Sign in
SCIM

Create a user

Creates a user. Must include the userName attribute and an email address. User will be created as an SSO user by default and a federated ID must be provided for the user.

post/scim/v2/Users

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

List of schema URNs defining the structure of the user resource.

activeboolean required

Indicates whether the user is active.

externalIdstring required

External identifier for the user.

userNamestring required

Unique username for the user.

preferredLanguagestring required

User's preferred language.

localestring required

User's locale.

Response

OK

schemasstring[]
idstring

Unique identifier for the user.

externalIdstring

External identifier for the user.

userNamestring

Unique username for the user.

displayNamestring

Display name of the user.

preferredLanguagestring

User's preferred language.

localestring

User's locale.

activeboolean

Indicates whether the user is active.

Changes

No recorded changes to this endpoint across all 4 revisions of this API.