Scim Patch — PATCH /api/v1/scim/v2/Users/{user_id}

Scim Patch

SCIM 2.0: Patch (partial update) a user.

Endpoint: PATCH /api/v1/scim/v2/Users/{user_id}

Authentication: Send the SCIM token issued for your identity provider in Authorization: Bearer <SCIM token>.

Parameters

Name	In	Required	Type	Default	Description
user_id	path	yes	string (uuid)
attributes	query	no	string or null
excludedAttributes	query	no	string or null
Authorization	header	yes	string

Request body

Content type	Body	Required
application/json	SCIMPatchRequestPayload	yes

Responses

Status	Meaning	Body
200	Successful Response	Not documented (application/scim+json)
422	Validation Error	HTTPValidationError (application/json)

Response fields not documented. The API specification does not describe the body of every response this endpoint returns, so this page cannot list those fields. The body is not empty. To see it, call the endpoint on your own installation. All endpoints with undocumented responses.

Errors this endpoint returns, read from its source code:

• 400, with messages such as “At least one PATCH operation is required”, “active must be a boolean”, “emails must contain a valid value”, and 2 other messages
• 404

It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.

More details

• Group: SCIM 2.0
• Operation ID: scim_patch_api_v1_scim_v2_Users__user_id__patch
• Source code: backend/app/routers/scim.py, line 608
• Specification: OpenAPI JSON