Turn On or Off, Set Group Rules
Turn SCIM on or off, and set the group rules: each rule gives one of the endpoint's roles to the members of one group of your identity provider. Saving the rules gives every SCIM user the roles the new rules give at once, and removes those the old rules gave and the new don't. Roles given by hand stay. Send either field or both.
Path parameters
uuid string (uuid) Req
The endpoint's
uuid from /endpoints.Request body
enabled boolean
true answers your provider's calls again (it needs a token: Make a Token turns SCIM on by itself). false refuses them and keeps the token.group_rules array
Every rule, replacing the ones saved:
[{"group": "Acme-Editors", "role_uuid": "<role uuid>"}]. The group's name exactly as your provider sends it, letter case included (up to 255 characters); a role of this endpoint (roles). Up to 200 rules. [] removes them all.Response (200 OK)
The SCIM settings, as Get SCIM answers them.
Errors
400 Bad Request
The body isn't JSON, has neither field or another field, a rule has no group name or one over 255 characters, a
role_uuid isn't a uuid, more than 200 rules, or "enabled": true without a token ("field": "enabled").401 Unauthorized
Missing auth.
403 Forbidden
Your role lacks
endpoints:update in the active account, or, to turn SCIM on or set rules, your plan doesn't have SCIM ("code": "entitlement_required", "entitlement_required": "endpoint_scim"). Turning it off always works.404 Not Found
No such endpoint in your active account, or a rule's role isn't one of its roles.
409 Conflict
To turn SCIM on or set rules: the endpoint is paused over your plan's quota (
"code": "quota_paused").Request
curl -X PUT "https://api.ngris.com/v1/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/scim" \
-H "X-API-KEY: <your_api_key>" \
-H "Content-Type: application/json" \
-d '{
"group_rules": [
{ "group": "Acme-Editors", "role_uuid": "0193f0b0-7777-7a00-8b00-0000000000a2" },
{ "group": "Acme-Admins", "role_uuid": "0193f0b0-7777-7a00-8b00-0000000000a3" }
]
}'
CLI
ngris api endpoint-scim update 019bb1e4-e785-77d2-9966-c3cff31d0a0e \
--group-rules '[{"group":"Acme-Editors","role_uuid":"0193f0b0-7777-7a00-8b00-0000000000a2"}]' --yes
# stop answering your identity provider, keep the token
ngris api endpoint-scim update 019bb1e4-e785-77d2-9966-c3cff31d0a0e --enabled=false --yes
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": []
}
Was this helpful?