API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Users

AdminUpdated Sep 11, 2026

Users

SCIM — a per-organization SCIM bearer token.

6 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /scim/v2/Users

List provisioned users, filterable by userName eq and index-paginated.

POST /scim/v2/Users

Provision a user and seat them in the token organization directory.

GET /scim/v2/Users/:id

Fetch one provisioned user by id. Non-members are 404.

PUT /scim/v2/Users/:id

Replace a provisioned user, including its active (deprovision) state.

PATCH /scim/v2/Users/:id

PatchOp a user; active:false deprovisions and revokes every session.

DELETE /scim/v2/Users/:id

Deprovision a user: revoke sessions and remove the directory membership.

Was this page helpful?
Users