Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

domain-controller

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' authority.

post/api/domain

Query parameters

oauth2ClientIdsstring[]

A list of oauth2 client registration ids, separated by comma ','

Request body

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring required

Domain name. Cannot be empty

oauth2Enabledboolean

Whether OAuth2 settings are enabled or not

propagateToEdgeboolean

Whether OAuth2 settings are enabled on Edge or not

Example request

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  }
}

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring required

Domain name. Cannot be empty

oauth2Enabledboolean

Whether OAuth2 settings are enabled or not

propagateToEdgeboolean

Whether OAuth2 settings are enabled on Edge or not

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  }
}