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

Mint a SCIM bearer token for the Environment

POST/api/v1/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 Option A

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

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission sso.manageAccount

Create, update, and delete SSO connections, verified domains and SCIM tokens. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Headers

  • X-Canopy-Environment

    The id of the Environment this request acts in. Required with an account API key, which belongs to the Account and names its Environment per request; an Environment key may send it only to name its own Environment. A missing header for an account key answers `400` (`api_key.environment_required`), one naming no Environment of the key's Account `400` (`api_key.environment_not_found`), and one naming another Environment than an Environment key's own `400` (`api_key.environment_mismatch`).

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. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

ScimTokenCreatedResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/scim-tokens" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -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
GETList IdP-pushed SCIM groups for the Environment
PUTMap a SCIM group to a role at a node
DELETEClear a SCIM group's role mapping
 Was this page helpful?

Tell us how we can improve this guide.

Canopy