1. Docs
  2. API Reference
  3. List active SCIM tokens for the Environment

List active SCIM tokens for the Environment

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

Lists the active SCIM tokens for the current Environment, newest first, with secrets masked to a token_preview (revoked tokens are excluded). The response is an unpaginated { items } array.

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.

Responses

application/json

  • itemsScimTokenResponseDto[]*

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.

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

Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/scim-tokens" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "token_preview": "string",
      "is_active": false,
      "last_used_at": "2026-04-20T12:00:00.000Z",
      "created_at": "2026-04-20T12:00:00.000Z"
    }
  ]
}
Related endpoints
POSTMint a SCIM bearer token 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.