Créer un domaine d’organisation

Créer un nouveau domaine pour cette Organisation.

POST /domains

Créer un domaine

cURL

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

201

createOrgDomainResponseExample

{
  "domain": "acme.com",
  "id": "ord_aW1UHetvkBWSWdCCe8DWq7",
  "org_id": "org_zW1UHutvkVWSWdCC",
  "status": "pending",
  "verification_host": "_ss-verification.org_zW1UHutvkVWSWdCC.acme.com",
  "verification_txt": "dove_text=asdfpiujnlewp-23849jdkfjzxcfpiawer"
}

Autorisations

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · requis

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

Corps

application/json

domain · string · requis

Nom de domaine.

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])$

Réponse

201

application/json

Le domaine a été créé avec succès pour l’organisation.

domain · string · requis

Nom de domaine.

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])$

id · string · requis · read-only

Identifiant du domaine de l’organisation.

Pattern: ^ord_[A-Za-z0-9]{22}$

org_id · string · requis · read-only

Identifiant de l’organisation.

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

status · enum<string> · requis

Statut du domaine de l’organisation.

Options disponibles: failed, pending, verified

verification_host · string · requis

Stocke le domaine complet où l’enregistrement TXT doit être ajouté.

verification_txt · string · requis

Valeur utilisée pour vérifier le domaine.