Sign in
SCIM

Partially update a user

Updates an existing user resource, overwriting values for specified attributes. The value of the {id} should be the user's corresponding user ID. Attributes that are not provided in the request will remain unchanged. Updating a value to " " will clear and remove the field from the user's profile.

patch/scim/v2/Users/{id}

Path parameters

idstring required

User ID to update

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Request body

schemasstring[] required

Example request

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "replace",
      "path": "/emails",
      "value": {
        "emails": [
          {
            "value": "updatedEmail@zuora.com",
            "display": "updatedEmail@zuora.com",
            "type": "home",
            "primary": false
          }
        ]
      }
    }
  ]
}

Response

OK

schemasstring[]

A list of schema URNs that are applicable to the user resource. This helps to identify the structure and format of the returned data.

idstring

The unique identifier for the user resource.

userNamestring

The username for the user. This is a unique identifier for the user in the system.

displayNamestring

The display name of the user, which may be used in UIs.

preferredLanguagestring

The preferred language of the user for communication.

localestring

The locale of the user, typically a language code combined with a region (e.g., 'en-US').

activeboolean

Indicates whether the user account is active or not.

Changes