XAxata
Organizations

Claim an email domain for SSO

Changed on

Claims an email domain and returns the DNS record that proves control of it. A claim is only a note to ourselves: nothing is registered against the domain until verification succeeds, so claiming a domain neither affects anyone's sign-in nor stops another organization claiming it first. A domain another organization has already registered is refused with 409, before any DNS record is published.

post/organizations/{organizationID}/sso/domains

Request

  • Base URL
    https://api.xata.tech
  • Auth
    OAuth 2
    Implicit: https://auth.xata.io/realms/xata/protocol/openid-connect/auth
    Scopes: org:write

Request body

domainstring required

Bare email domain to claim, for example acme.com.

Response

Domain claimed, pending verification

domainstring required

The claimed email domain

provider_aliasstring required

The alias an identity provider on this domain will be given. Derived from the organization and the domain, so it is known before the provider exists, which is what lets a client show the redirect URI to register with the provider up front.

verifiedboolean required

Whether control of the domain has been proven through DNS

missing_sincestring date-time nullable

When the daily recheck first found the record missing from a verified domain.

revokes_atstring date-time nullable

When the domain stops being verified if the record is still missing.

Changes

  • 5d5197f76970Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • a9044087aadfRevision changes
    • info

      removed the non-success response with the status