ThingsboardClient methods:
void deleteDomain(@Nonnull UUID id) // Delete Domain by ID (deleteDomain)
DomainInfo getDomainInfoById(@Nonnull UUID id) // Get Domain info by Id (getDomainInfoById)
PageDataDomainInfo getDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder) // Get Domain infos (getDomainInfos)
Domain saveDomain(@Nonnull Domain domain, @Nullable List<String> oauth2ClientIds) // Save or Update Domain (saveDomain)
void updateDomainOauth2Clients(@Nonnull UUID id, @Nonnull List<UUID> UUID) // Update oauth2 clients (updateDomainOauth2Clients)
void deleteDomain(@Nonnull UUID id)
DELETE /api/domain/{id}
Delete Domain by ID (deleteDomain)
Deletes Domain by ID. Referencing non-existing domain Id will cause an error. Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID |
null (empty response body)
DomainInfo getDomainInfoById(@Nonnull UUID id)
GET /api/domain/info/{id}
Get Domain info by Id (getDomainInfoById)
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID |
DomainInfo
PageDataDomainInfo getDomainInfos(@Nonnull Integer pageSize, @Nonnull Integer page, @Nullable String textSearch, @Nullable String sortProperty, @Nullable String sortOrder)
GET /api/domain/infos
Get Domain infos (getDomainInfos)
Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| pageSize | Integer | Maximum amount of entities in a one page | |
| page | Integer | Sequence number of page starting from 0 | |
| textSearch | String | Case-insensitive 'substring' filter based on domain's name | [optional] |
| sortProperty | String | Property of entity to sort by | [optional] |
| sortOrder | String | Sort order. ASC (ASCENDING) or DESC (DESCENDING) | [optional] |
PageDataDomainInfo
Domain saveDomain(@Nonnull Domain domain, @Nullable List<String> oauth2ClientIds)
POST /api/domain
Save or Update Domain (saveDomain)
Create or update the Domain. When creating domain, platform generates Domain Id as time-based UUID. The newly created Domain Id will be present in the response. Specify existing Domain Id to update the domain. Referencing non-existing Domain Id will cause 'Not Found' error. Domain name is unique for entire platform setup. Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| domain | Domain | ||
| oauth2ClientIds | List | A list of oauth2 client registration ids, separated by comma ',' | [optional] |
Domain
void updateDomainOauth2Clients(@Nonnull UUID id, @Nonnull List<UUID> UUID)
PUT /api/domain/{id}/oauth2Clients
Update oauth2 clients (updateDomainOauth2Clients)
Update oauth2 clients for the specified domain. Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | UUID | ||
| UUID | List |
null (empty response body)