1. Docs
  2. API Reference
  3. Claim a domain for admin SSO

Claim a domain for admin SSO

POST/api/v1/sso/domains

Claims an email domain for admin-SSO routing and issues a DNS TXT challenge (a canopy-domain-verification= token published under a _canopy-verification subdomain). The domain is normalized from a pasted URL or host and rejected (400) if it is malformed or a known public email provider. Idempotent: re-claiming an existing (Account, domain) returns the existing row and token rather than minting a new challenge. Emits an sso.domain.claimed audit row and returns 201.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission sso.manageAccount

Create, update, and delete SSO connections, verified domains and SCIM tokens. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Request body

application/json

domainstring Required

Domain to claim, e.g. `acme.com`.

Responses

application/json

  • dataSsoDomainResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

SsoDomainResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/sso/domains" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "string"
  }'
Response
{
  "data": {
    "domain": "string",
    "status": "pending",
    "txt_record_name": "string",
    "txt_record_value": "string",
    "verified_at": "2026-04-20T12:00:00.000Z",
    "last_checked_at": "2026-04-20T12:00:00.000Z",
    "failure_reason": "string"
  }
}
 Related endpoints
GETList SSO connections
POSTCreate an SSO connection
GETGet an SSO connection
PATCHUpdate an SSO connection
DELETEDelete an SSO connection
POSTActivate an SSO connection
POSTDisable an SSO connection
GETList OAuth-client links for an end-user connection
POSTLink an OAuth client to an end-user connection
PATCHUpdate an OAuth-client link
DELETEUnlink an OAuth client from a connection
GETList an OAuth client's SSO connection links
GETList Environments reachable by SSO
GETList Environment bindings for an end-user connection
POSTBind an end-user connection to an Environment
PATCHUpdate an Environment binding
DELETEUnbind an end-user connection from an Environment
GETList the organizations an end-user connection is bound to
POSTStart a test sign-in
GETRead a test sign-in
GETList a connection's recent login attempts
GETList SSO domain claims
POSTVerify a claimed domain
DELETERemove a domain claim
 Was this page helpful?

Tell us how we can improve this guide.

Canopy