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

Claim a domain for admin SSO

POST/portal/v1/accounts/{accountSlug}/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

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

Requires capability sso.manageSecurity

Manage SSO connections, domains, and directory sync. Granted through an administrator role in the Admin Workspace; a valid token 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*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

SsoDomainResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/sso/domains" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -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 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
GETList a connection's recent login attempts
GETList an OAuth client's SSO connection links
GETList Environments reachable by SSO
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