{ "opencollection": "1.0.0", "info": { "name": "ThingsBoard Admin admin-controller domain-controller API", "version": "4.3.0.3DEMO" }, "items": [ { "info": { "name": "domain-controller", "type": "folder" }, "items": [ { "info": { "name": "Update Oauth2 Clients (updateOauth2Clients)", "type": "http" }, "http": { "method": "PUT", "url": "https://demo.thingsboard.io/api/domain/:id/oauth2Clients", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update oauth2 clients for the specified domain. " }, { "info": { "name": "Save or Update Domain (saveDomain)", "type": "http" }, "http": { "method": "POST", "url": "https://demo.thingsboard.io/api/domain", "params": [ { "name": "oauth2ClientIds", "value": "", "type": "query", "description": "A list of oauth2 client registration ids, separated by comma ','" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update the Domain. When creating domain, platform generates Domain Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). 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.\n\nDomain name is unique for entire platform setup.\n\n\n\nAvailable for users with 'SYS_ADMIN' authority." }, { "info": { "name": "Get Domain Infos (getTenantDomainInfos)", "type": "http" }, "http": { "method": "GET", "url": "https://demo.thingsboard.io/api/domain/infos", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Maximum amount of entities in a one page" }, { "name": "page", "value": "", "type": "query", "description": "Sequence number of page starting from 0" }, { "name": "textSearch", "value": "", "type": "query", "description": "Case-insensitive 'substring' filter based on domain's name" }, { "name": "sortProperty", "value": "", "type": "query", "description": "Property of entity to sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)" } ] }, "docs": "\n\nAvailable for users with 'SYS_ADMIN' authority." }, { "info": { "name": "Get Domain Info by Id (getDomainInfoById)", "type": "http" }, "http": { "method": "GET", "url": "https://demo.thingsboard.io/api/domain/info/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "\n\nAvailable for users with 'SYS_ADMIN' authority." }, { "info": { "name": "Delete Domain by ID (deleteDomain)", "type": "http" }, "http": { "method": "DELETE", "url": "https://demo.thingsboard.io/api/domain/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes Domain by ID. Referencing non-existing domain Id will cause an error.\n\nAvailable for users with 'SYS_ADMIN' authority." } ] } ], "bundled": true }