1. Docs
  2. API Reference
  3. Mint a SCIM bearer token for the Environment

Mint a SCIM bearer token for the Environment

POST/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/scim-tokens

Mints a new SCIM bearer token for the current Environment, returning the raw token exactly once alongside its id, token_preview, and the SCIM base_url the IdP admin pastes into Okta/Entra. The raw value is bcrypt-hashed for storage (with a SHA-256 lookup hash) and is never recoverable afterwards. Accepts an optional human name label 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.

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

namestring Optional

Human label for the token, shown in the portal token list (e.g. the IdP it's pasted into). Optional.

Responses

application/json

  • dataScimTokenCreatedResponseDto*

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

ScimTokenCreatedResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/scim-tokens" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'
Response
{
  "data": {
    "id": "string",
    "name": "string",
    "token": "string",
    "token_preview": "string",
    "base_url": "string",
    "expires_at": "2026-04-20T12:00:00.000Z"
  }
}
 Related endpoints
GETList active SCIM tokens for the Environment
GETRecent SCIM sync activity for the Environment
DELETERevoke a SCIM token
 Was this page helpful?

Tell us how we can improve this guide.

Canopy