Skip to main content

Claim ownership of an email domain​

Record a pending ownership claim for an email domain and return the DNS TXT record that proves ownership (txt_record). Publish that record; verification is currently performed by SlashID (a scheduled DNS check will follow).

A verified domain routes Console logins for <anything>@<domain> straight to this organization's configured identity provider (one-step SSO). Only organizations managed through the Console can claim domains. Claiming a domain that is already claimed by this organization returns the existing claim unchanged. The domain is stored in canonical form (lowercase, ASCII); public suffixes such as com or co.uk cannot be claimed.

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
  • SlashID-Required-Consistency string

    Possible values: [local_region, all_regions]

    Default value: local_region

    The consistency level required for this request. If the consistency level is not achieved within the timeout, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. Allowed values: * local_region: Wait while the request executes in the local region. * all_regions: Wait while the request executes across all regions. You can learn more about our replication model on our Cross-region Replication Model page.

  • SlashID-Required-Consistency-Timeout integer

    Possible values: >= 1 and <= 120

    Default value: 30

    The maximum amount of seconds to wait for the requested consistency level to be achieved. If the consistency level is not achieved within this time, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. You can learn more about our replication model on our Cross-region Replication Model page.

Request Body required
  • domain string required
Responses

Claim recorded (or already present)

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • code string

    Machine-readable reason, present only for errors that define one. Values today: unserved_org_region (the organization is homed in a region this deployment does not serve), wrong_region (the request must be sent to the organization's home region), region_route_missing (this instance has no route to the organization's home region).

  • result object
  • organization_id string
  • domain string

    The domain in canonical form (lowercase, ASCII)

  • status string

    Possible values: [pending, verified]

    Verification state of an email domain ownership claim

  • verification_method string

    Possible values: [dns_txt, manual]

    How ownership of the email domain was established

  • txt_record object

    The DNS TXT record that proves ownership of the domain

  • name string
  • value string
  • verified_at date-time
  • verified_by string

    ID of the super-admin who verified the domain manually, when applicable

  • created_at date-time
  • last_updated date-time