THIS WEEK The Essential Guide to URL Management Read this week's article →
All API references

SCIM API

Automate enterprise workspace membership with SCIM 2.0.

/api/scim/v2/{workspaceId}/Users Workspace SCIM token

Authentication

SCIM uses the separate bearer token created in the enterprise workspace's security settings—not a gtn_ public API key. Treat that token as a server-side secret and scope the connector to the workspace ID shown in the dashboard.

Method Endpoint Purpose
GET /api/scim/v2/{workspaceId}/Users List workspace members
POST /api/scim/v2/{workspaceId}/Users Provision a member
GET /api/scim/v2/{workspaceId}/Users/{memberId} Read one member
PATCH /api/scim/v2/{workspaceId}/Users/{memberId} Update or activate/deactivate a member
DELETE /api/scim/v2/{workspaceId}/Users/{memberId} Remove a member

Send and accept application/scim+json. The endpoints return SCIM resource and error shapes suitable for an identity-provider provisioning connector. Workspace owners should create a dedicated token for each provider and rotate it if the connector or its logs expose the credential.


Return to all API references