Associate a domain with an Identity Provider

Associate a domain with an Identity Provider specified by ID for this Organization. The domain must be claimed and verified.

POST /identity-providers/{idp_id}/domains

Associate a domain with an Identity Provider

cURL

curl --request POST \
  --url https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "my-domain.com"
}
'

201

createIdPResponseExample

{
  "domain": "my-domain.com"
}

Authorizations

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

idp_id · string · required · read-only

Identity provider identifier.

Pattern: ^con_[A-Za-z0-9]{16}$

Body

application/json

domain · string · required

Domain name.

Pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$

Response

201

application/json

Domain successfully associated with identity provider.

domain · string · required

Domain name.

Pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$