API ReferenceScim
Patch a user — incl. active toggle (SCIM 2.0 PATCH)
PATCH
/v1/idp/scim/v2/Users/{user_id}Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Path Parameters
user_id*User Id
Query Parameters
attributes?string|null
excludedAttributes?string|null
Header Parameters
If-Match?string|null
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/idp/scim/v2/Users/string" \ -H "Content-Type: application/json" \ -d '{ "Operations": [ { "op": "replace", "path": "active", "value": false } ], "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ] }'{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "2819c223-7f76-453a-919d-413861904646", "userName": "jdoe", "active": true, "externalId": "ext-8a1f", "displayName": "John Doe", "name": { "formatted": "John Doe" }, "emails": [ { "value": "jdoe@corp.com", "primary": true, "type": "work" } ], "meta": { "resourceType": "User", "created": "2026-06-10T22:05:00+00:00", "lastModified": "2026-06-10T22:05:00+00:00", "version": "W/\"a1b2c3d4e5f60718\"", "location": "https://acme.example.com/v1/idp/scim/v2/Users/2819c223-7f76-453a-919d-413861904646" }}{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:Error" ], "status": "404", "detail": "User 2819c223-7f76-453a-919d-413861904646 not found"}{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:Error" ], "status": "409", "detail": "userName already exists", "scimType": "uniqueness"}{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:Error" ], "status": "412", "detail": "resource has changed"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string", "input": null, "ctx": {} } ]}