1. Docs
  2. API Reference
  3. Get the environment's custom auth domain

Get the environment's custom auth domain

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

Returns the custom auth domain configured for this Environment, including its verification status and the exact CNAME + TXT records the customer must publish. 404 when none is configured.

Authentication

Bearer TokenAuthorization

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

Requires capability sso.viewSecurity

View 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.

Responses

application/json

  • dataAuthDomainResponseDto*

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 GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/auth-domain" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
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
POSTAdd a 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