Get SCIM

GET /v1/endpoints/{uuid}/scim

The endpoint's SCIM: whether your identity provider can manage its users, the base URL to give it, the token by its last 4 characters, how many users and groups SCIM keeps, the group rules, and the latest 20 calls of the last 30 days. The token itself is shown only when it is made (Make a Token). How SCIM works: SCIM for your users.

Path parameters

uuid string (uuid) Req
The endpoint's uuid from /endpoints.

Response (200 OK)

enabled boolean
Your identity provider's calls are answered.
plan_includes boolean
Your plan has SCIM (endpoint_scim). Without it, the provider's calls are refused.
base_url string
What your identity provider calls: https://api.ngris.com/scim/v2/endpoints/{uuid}.
has_token · token_hint · token_created_at
A token exists, its last 4 characters, and when it was made.
last_request_at string (date-time)
Your provider's last call; left out before the first.
users · groups integer
The users and groups SCIM keeps.
group_rules array
Each {"group", "role_uuid", "role_name"}: the members of the group get the role.
activity array
The latest calls first: at, action (user.created, user.linked, user.updated, user.deactivated, user.reactivated, user.deleted, group.created, group.updated, group.deleted), the answer's status, the subject (a userName or a group name) and, for a refusal, the detail.

Errors

401 Unauthorized
Missing auth.
403 Forbidden
Your role lacks endpoints:read in the active account.
404 Not Found
No such endpoint in your active account.
Request
curl "https://api.ngris.com/v1/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/scim" \ -H "X-API-KEY: <your_api_key>"
CLI
ngris api endpoint-scim get 019bb1e4-e785-77d2-9966-c3cff31d0a0e
Response — 200 OK
{ "enabled": true, "plan_includes": true, "base_url": "https://api.ngris.com/scim/v2/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e", "has_token": true, "token_hint": "Qx7k", "token_created_at": "2026-11-10T09:12:44Z", "last_request_at": "2026-11-20T14:56:02Z", "users": 12, "groups": 2, "group_rules": [ { "group": "Acme-Editors", "role_uuid": "0193f0b0-7777-7a00-8b00-0000000000a2", "role_name": "editor" }, { "group": "Acme-Admins", "role_uuid": "0193f0b0-7777-7a00-8b00-0000000000a3", "role_name": "admin" } ], "activity": [ { "at": "2026-11-20T14:56:02Z", "action": "user.deactivated", "status": 200, "subject": "marta.ilves@acme.com" }, { "at": "2026-11-20T13:41:17Z", "action": "user.created", "status": 409, "subject": "ana@acme.com", "detail": "A user of this endpoint has this email and can't be taken over by SCIM (they signed up by themselves, are managed by the agent, are invited or revoked, or SCIM manages them under another userName)." } ] }
Was this helpful?
On this page
Get SCIM
Was this helpful?