Update a user

Updates an existing user resource, overwriting all values for a user even if an attribute is empty or not provided. If an attribute that had been set previously is left blank during a PUT operation, the new value will be blank in accordance with the data type of the attribute and the storage provider. Deactivated users can be re-enabled by setting the active attribute to true. The value of the should be the user's corresponding user ID.

Request
path Parameters
id
required
string

The ID of the user to be updated.

header Parameters
Idempotency-Key
string <= 255 characters

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-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

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-Ids
string

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 schema: application/json
required
schemas
Array of strings
id
string or null
externalId
string
object
userName
string
object
displayName
string
preferredLanguage
string
locale
string
active
boolean
Array of objects
Array of objects
Array of objects
object
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

put/scim/v2/Users/{id}
Request samples
application/json
{
  • "schemas": [
    ],
  • "id": "4ae68f98-2762-4001-b95c-34569b413e8e",
  • "externalId": "Amy+test5",
  • "meta": {},
  • "userName": "Amy+test6",
  • "name": {
    },
  • "displayName": "Amy Lawrence",
  • "preferredLanguage": "en",
  • "locale": "en-US",
  • "active": true,
  • "emails": [
    ],
  • "groups": [
    ],
  • "roles": [
    ],
  • "urn:zuora:scim:schemas:1.0:UserExtension": {
    }
}
Response samples
application/json
{
  • "id": "123456",
  • "userName": "johndoe",
  • "displayName": "John Doe",
  • "active": true,
  • "emails": [
    ],
  • "meta": {
    },
  • "schemas": [
    ],
  • "totalResults": 1,
  • "resources": [
    ],
  • "startIndex": 1,
  • "itemsPerPage": 1
}