Skip to navigation
OneIDScim

Create a user

View as Markdown
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.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Idempotency-KeystringOptional<=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-EncodingstringOptional

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-EncodingstringOptional

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-IdstringOptional<=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-IdsstringOptional

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

This endpoint expects a list of objects.
schemaslist of stringsRequired
List of schema URNs defining the structure of the user resource.
nameobjectRequired
Name details of the user.
activebooleanRequired
Indicates whether the user is active.
emailslist of objectsRequired
List of email addresses associated with the user.
roleslist of objectsRequired
Roles assigned to the user.
externalIdstringRequired
External identifier for the user.
userNamestringRequired
Unique username for the user.
preferredLanguagestringRequired
User's preferred language.
localestringRequired
User's locale.
urn:zuora:scim:schemas:1.0:UserExtensionobjectRequired
Custom extension schema with additional attributes for the user.

Response headers

Content-EncodingstringOptional
RateLimit-LimitstringOptional
RateLimit-Remainingdouble
RateLimit-Resetdouble
Zuora-Request-IdstringOptional
Zuora-Track-IdstringOptional

Response

OK
schemaslist of stringsOptional
idstringOptional
Unique identifier for the user.
externalIdstringOptional
External identifier for the user.
metaobjectOptional
userNamestringOptional
Unique username for the user.
nameobjectOptional
displayNamestringOptional
Display name of the user.
preferredLanguagestringOptional
User's preferred language.
localestringOptional
User's locale.
activebooleanOptional
Indicates whether the user is active.
emailslist of objectsOptional
roleslist of objectsOptional
urn:zuora:scim:schemas:1.0:UserExtensionobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error