Patch User (SCIM)

Partially update a user using SCIM 2.0 PATCH operation.

Quick Navigation

• Endpoint
• Headers
• Path Parameters
• Request Body
• Operations
• Response
• Success (200)
• Features
• Example
• Related Endpoints

Endpoint

PATCH /scim/v2/Users/{user_id}

Headers

Header	Required	Description
Authorization	Yes	Bearer <scim_bearer_token>
Content-Type	Yes	application/scim+json
Accept	Yes	application/scim+json or application/json

Path Parameters

Parameter	Type	Required	Description
user_id	string	Yes	User ID

Request Body

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "replace",
      "path": "name.givenName",
      "value": "Jane"
    },
    {
      "op": "replace",
      "path": "active",
      "value": false
    }
  ]
}

Operations

Supported operations:

• add - Add a new value
• remove - Remove a value
• replace - Replace a value

Response

Success (200)

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "id": "123",
  "userName": "user@example.com",
  "name": {
    "formatted": "Jane Doe",
    "familyName": "Doe",
    "givenName": "Jane"
  },
  "active": false,
  "emails": [
    {
      "value": "user@example.com",
      "primary": true
    }
  ],
  "meta": {
    "resourceType": "User",
    "created": "2024-01-01T12:00:00Z",
    "lastModified": "2024-01-01T14:00:00Z",
    "location": "/scim/v2/Users/123"
  }
}

Features

• SCIM 2.0 compliant
• Partial updates only (specify only fields to change)
• Supports add, remove, and replace operations
• More efficient than PUT for small changes

Example

curl -X PATCH "https://api.rivergen.com/scim/v2/Users/123" \
  -H "Authorization: Bearer <scim_bearer_token>" \
  -H "Content-Type: application/scim+json" \
  -H "Accept: application/scim+json" \
  -d '{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
      {
        "op": "replace",
        "path": "active",
        "value": false
      }
    ]
  }'

Related Endpoints

• Update User - Full replacement (PUT)
• Get User - Get user by ID