Organizations

Check the DNS record for a claimed domain

Changed on

Looks up the challenge TXT record. Verification is a poll, not a command: a missing or stale record is reported as verified: false on a 200 rather than as an error, so a client can retry while DNS propagates. Verifying a domain that lost its verification restores its provider, with enforcement off.

post/organizations/{organizationID}/sso/domains/{domain}/verify

Request

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

Response

Current state of the domain after checking DNS

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