Create Domain

ApiScope: manage.domain.write
API Scope Level: ServiceSubscriberScope

application/json

Request Body required

domainName string
ssoPartnerUUID string
description string

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
domainDTO object
name string
description string
uuid string
ssoPartnerDTO object
name string
type string
Possible values: [SAML_20]
description string
uuid string
attributes object
property name* string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "domainDTO": {
    "name": "string",
    "description": "string",
    "uuid": "string",
    "ssoPartnerDTO": {
      "name": "string",
      "type": "SAML_20",
      "description": "string",
      "uuid": "string",
      "attributes": {}
    }
  }
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

POST /v2/domains

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

Body required

{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}

curl / cURL

curl -L -X POST '/manage/v2/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}'

python / requests

curl -L -X POST '/manage/v2/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}'

go / native

curl -L -X POST '/manage/v2/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}'

nodejs / axios

curl -L -X POST '/manage/v2/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}'

ruby / Net::HTTP

curl -L -X POST '/manage/v2/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}'

csharp / RestSharp

curl -L -X POST '/manage/v2/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}'

php / cURL

curl -L -X POST '/manage/v2/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}'

java / OkHttp

curl -L -X POST '/manage/v2/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}'

powershell / RestMethod

curl -L -X POST '/manage/v2/domains' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "domainName": "string",
  "ssoPartnerUUID": "string",
  "description": "string"
}'