1. Docs
  2. API Reference
  3. Update the Account's hosted-page settings

Update the Account's hosted-page settings

PATCH/portal/v1/accounts/{accountSlug}/auth-settings

Replaces allowed_return_origins. Each entry must be an origin only (scheme, host and optional port), https unless the host is localhost; entries are canonicalised (lowercased, trailing slash dropped) and de-duplicated. One bad entry refuses the whole request with 400. The Account's other settings are untouched. Requires auth_settings.manage. Writes an account.updated audit row.

Authentication

Bearer TokenAuthorization

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

Requires capability auth_settings.manageDeveloper Console

Change Environment sign-in settings. 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.

Request body

application/json

allowed_return_originsstring[] Required

Origins a hosted page may send someone back to when it finishes (password reset, email verification, invite acceptance), e.g. `https://app.example.com`. Each entry is an origin only, `https` unless the host is localhost. Replaces the whole list; an empty list means no hosted page offers a way back.

Responses

application/json

  • dataAccountAuthSettingsResponseDto*

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

AccountAuthSettingsResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/portal/v1/accounts/value/auth-settings" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "allowed_return_origins": [
      "https://app.example.com"
    ]
  }'
Response
{
  "data": {
    "allowed_return_origins": [
      "https://app.example.com"
    ]
  }
}
 Related endpoints
GETGet the current Account
PATCHUpdate the Account name or settings
DELETEDelete the Account (owner only)
GETGet the Account's hosted-page settings
GETGet the Account's policy for its administrators' second factor
PATCHUpdate the Account's policy for its administrators' second factor
 Was this page helpful?

Tell us how we can improve this guide.

Canopy