1. Docs
  2. API Reference
  3. Add a custom auth domain

Add a custom auth domain

POST/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/auth-domain

Adds a custom auth domain (e.g. auth.yourapp.com) to this Environment so its hosted sign-in, OIDC discovery, identity-auth API and hosted pages can be served first-party from the customer's own host, with the domain as the issuer of the tokens minted there. Parks it pending with a TXT-challenge token; the customer publishes the DNS records, then calls verify.

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.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

Request body

application/json

domainstring Required

The hostname to serve this Environment's auth from, e.g. auth.yourapp.com. Must be a subdomain you control.

Responses

application/json

  • dataAuthDomainResponseDto*

application/json

  • errorApiErrorBodyDto*

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.

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

AuthDomainResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/auth-domain" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "auth.yourapp.com"
  }'
Response
{
  "data": {
    "id": "string",
    "domain": "auth.yourapp.com",
    "tls_status": "pending",
    "dns_verified_at": "2026-04-20T12:00:00.000Z",
    "active": false,
    "dns_records": [
      {
        "type": "CNAME",
        "name": "string",
        "value": "string"
      }
    ]
  }
}
 Related endpoints
GETGet the environment's custom auth domain
DELETERemove a custom auth domain
POSTVerify a custom auth domain's DNS
 Was this page helpful?

Tell us how we can improve this guide.

Canopy