Replace a SCIM token without an outage
/api/v1/scim-tokens/{id}/rotateMints a replacement for the SCIM token id in the current Environment and shortens the current token's life to 7 days rather than revoking it, so the identity provider can be moved to the new token before the old one stops working. Returns the replacement's raw token exactly once, with its id, token_preview, expires_at (365 days out) and the SCIM base_url. The replacement counts toward the directory's 10 live tokens, and so does the old token until its 7 days end.
Authentication
Authorization Option A JWT access token. Never send alongside X-API-Key: a request carrying both is refused.
X-API-Key Option B API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.
sso.manageAccountCreate, 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.
Path Parameters
idstring Required Headers
X-Canopy-EnvironmentThe 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
data *ScimTokenCreatedResponseDto
application/json
error *ApiErrorBodyDto
application/json
error *ApiErrorBodyDto
application/json
error *ApiErrorBodyDto
application/json
error *ApiErrorBodyDto
application/json
error *ApiErrorBodyDto
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.
authorization.deniedForbiddenThe 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.
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
curl -X POST "https://auth.canopy-io.com/api/v1/scim-tokens/value/rotate" \ -H "X-Canopy-Environment: value" \ -H "X-API-Key: $CANOPY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'
{ "data": { "id": "string", "name": "string", "token": "string", "token_preview": "string", "base_url": "string", "expires_at": "2026-04-20T12:00:00.000Z" } }
Tell us how we can improve this guide.