organisations

Attach an email domain

Attach an email domain to the account, proxied from the control plane. Account admins only. The request body is forwarded verbatim. Attach is idempotent: a fresh attach is a 201, and resuming an already-attached domain is a 200.

post/registry/v1/organisations/{org_id}/domains

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/organisations/{org_id}/domains
  • Auth: HTTP bearer

Path parameters

org_idstring required

The account id (must be the caller's own).

Headers

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Response

The domain was already attached; the attach resumed with a fresh verification link.

created_atstring date-time required

When the domain was attached.

domainstring required

The domain name.

expires_atstring date-time

When portal_url stops working. Absent whenever portal_url is.

failure_reasonstring

Why verification failed. Present only when state is failed.

idstring required

The domain record's id.

kind'claim' | 'invite_allow' required

What an attached email domain is for.

org_idstring required

The organisation the domain is attached to.

portal_urlstring

The admin-portal link that completes verification. Absent once the domain is verified, and for invite_allow entries, which are never verified.

statestring required

The verification state: unverified, pending, verified, or failed.

updated_atstring date-time required

When the domain record last changed.

verified_atstring date-time

When the domain was verified, once it is.

verified_via'dns' | 'signup'

How a verified domain was proven.

Changes

No recorded changes to this operation across all 1 revision of this API.