Recent SCIM sync activity for the Environment

GET

/api/v1/scim-tokens/activity

Returns the most recent SCIM activity for the Environment's directory: the latest audit rows of the sync itself (scim.*: provision, deprovision, group changes, mapping, and failures) and of the connection (scim_directory.* and scim_token.*), newest first, capped at 20. Each row projects actor, resource, and outcome, lifting a failure detail from metadata so admins can debug pushes without opening the global audit log. The response is an unpaginated { items } array.

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.viewAccount

View SSO connections, verified domains and SCIM directories. 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`).

Responses

application/json

itemsScimActivityResponseDto[]*

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

ScimActivityResponseDtoView all properties on this resource

Request

curl -X GET "https://auth.canopy-io.com/api/v1/scim-tokens/activity" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY"

Response

{
  "items": [
    {
      "id": "string",
      "action": "string",
      "actor_type": "scim",
      "actor_label": "string",
      "resource_type": "string",
      "resource_label": "string",
      "outcome": "success",
      "detail": "string",
      "created_at": "2026-04-20T12:00:00.000Z"
    }
  ]
}

GETList active SCIM tokens for the Environment
POSTMint a SCIM bearer token 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.