Skip to main content
POST
Claim an email domain for SSO

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationID
string
required

Unique identifier for a specific organization

Pattern: [a-zA-Z0-9_-~:]+

Body

application/json

Request payload for claiming an email domain for SSO

domain
string
required

Bare email domain to claim, for example acme.com. Wildcards and public email providers are rejected.

Response

Domain claimed, pending verification

An email domain claimed by an organization for SSO

domain
string
required

The claimed email domain

provider_alias
string
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.

verified
boolean
required

Whether control of the domain has been proven through DNS

verification
object | null

The DNS record that proves control of the domain. Absent once the domain is verified.