# Bulk create users

Creates multiple users within an organization.

Endpoint: POST /scim/v2/Users/bulk
Version: 2026-08-14
Security: bearerAuth

## Request fields (application/json):

  - `schemas` (array)
    A list of schema URNs that describe the structure of the user resource. These URNs indicate the schemas that are applicable to the user data.

  - `name` (object)

  - `name.givenName` (string)
    The given (or first) name of the user.

  - `name.familyName` (string)
    The family (or last) name of the user.

  - `name.formatted` (string)
    The full name of the user in a formatted string. Typically includes given name and family name.

  - `emails` (array)

  - `emails.value` (string)
    The email address of the user.

  - `emails.type` (string)
    The type of email address (e.g., 'work', 'home').

  - `emails.primary` (boolean)
    Indicates whether this email address is the user's primary email.

  - `roles` (array)

  - `roles.value` (string)
    The role assigned to the user, typically represented by an identifier.

  - `roles.display` (string,null)

  - `userName` (string)
    The username or login name of the user.

  - `preferredLanguage` (string)
    The preferred language of the user, typically represented by a locale code (e.g., 'en', 'fr').

  - `locale` (string)
    The locale of the user, typically represented by a locale code (e.g., 'en-US', 'fr-FR').

  - `urn:zuora:scim:schemas:1.0:UserExtension` (object)

  - `urn:zuora:scim:schemas:1.0:UserExtension.schemas` (array)
    A list of schema URNs that describe additional extensions or custom schemas applied to the user resource.

  - `urn:zuora:scim:schemas:1.0:UserExtension.organizationId` (string)
    An identifier for the organization to which the user belongs. This may be used for organizational or grouping purposes.

## Response 200 fields (application/json):

  - `schemas` (array)
    A list of schema URNs that describe the structure of the response. These URNs indicate the schemas that are applicable to the data.

  - `id` (string,null)
    A unique identifier for the response object, often used for referencing or tracking.

  - `externalId` (string,null)
    An external identifier for the resource, often used for integration with external systems.

  - `totalResults` (integer)
    The total number of user resources available in the response, irrespective of pagination.

  - `resources` (array)

  - `resources.schemas` (array)
    A list of schema URNs that describe the structure of the individual user resource. These URNs indicate the schemas applicable to the user data.

  - `resources.id` (string,null)
    A unique identifier for the user resource.

  - `resources.externalId` (string,null)
    An external identifier for the resource, often used for integration with external systems.

  - `resources.meta` (object,null)

  - `resources.meta.created` (string)
    The date and time when the user resource was created, in ISO 8601 format.

  - `resources.meta.resourceType` (string)
    The type of the resource, typically 'User' for user resources.

  - `resources.meta.location` (string)
    The URL where the user resource can be accessed.

  - `resources.userName` (string)
    The username or login name for the user.

  - `resources.name` (object)

  - `resources.name.formatted` (string)
    The full name of the user, formatted as a single string.

  - `resources.name.familyName` (string)
    The family (or last) name of the user.

  - `resources.name.givenName` (string)
    The given (or first) name of the user.

  - `resources.displayName` (string)
    The display name of the user, typically used for user identification.

  - `resources.preferredLanguage` (string)
    The user's preferred language, typically represented by a locale code (e.g., 'en', 'fr').

  - `resources.locale` (string)
    The user's locale, typically represented as a locale code (e.g., 'en-US', 'fr-FR').

  - `resources.active` (boolean)
    Indicates whether the user is currently active or not.

  - `resources.emails` (array)

  - `resources.emails.value` (string)
    The email address of the user.

  - `resources.emails.display` (string)
    A display name or description for the email address.

  - `resources.emails.type` (string)
    The type of email address (e.g., 'work', 'home').

  - `resources.emails.primary` (boolean)
    Indicates whether this email address is the primary one for the user.

  - `resources.roles` (array)

  - `resources.roles.value` (string)
    The role assigned to the user, often represented by an identifier.

  - `resources.roles.display` (string,null)

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension` (object)

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.schemas` (array)
    A list of schema URNs that describe additional extensions or custom schemas applied to the user resource.

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.organizationId` (string)
    An identifier for the organization to which the user belongs. This may be used for organizational or grouping purposes.
    Example: "ec141dc2-901e-4813-a25d-ef480cff1e26"

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.status` (string)
    The current status of the user. Example values might include 'NEW', 'ACTIVE', 'INACTIVE', etc.
    Example: "NEW"

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.ssoEnabled` (boolean)
    Indicates whether Single Sign-On (SSO) is enabled for the user.

  - `resources.urn:zuora:scim:schemas:1.0:UserExtension.region` (string)

  - `startIndex` (integer)

  - `itemsPerPage` (integer)

## Response 401 fields (application/json):

  - `success` (boolean)
    Indicates whether the operation was successful or not. For a 401 Unauthorized error, this will be false.

  - `reasons` (array)

  - `reasons.message` (string)
    A brief description of the reason for the unauthorized access. This message typically explains why the request is unauthorized, such as missing or invalid authentication credentials.

  - `reasons.code` (string)
    An error code that provides a more specific identification of the issue. This code can be used for debugging or logging purposes.

## Response 403 fields (application/json):

  - `timestamp` (string)
    The date and time when the error occurred, in ISO 8601 format.

  - `status` (integer)
    The HTTP status code for the response, which is 403 in this case, indicating that access to the resource is forbidden.

  - `error` (string)
    A short, descriptive string representing the error type. For a 403 response, this is typically 'Forbidden'.

  - `message` (string)
    A human-readable message providing additional details about the error. This message typically explains why access is denied.

  - `path` (string)
    The URI path of the resource where the error occurred.

## Response 404 fields (application/json):

  - `schemas` (array)
    A list of schema URNs that describe the structure of the error response. This helps in understanding the error context.

  - `status` (string)
    The HTTP status code for the response, which is 404 in this case, indicating that the requested resource could not be found.

  - `detail` (string)
    A human-readable message providing additional information about the error. This typically explains what resource was not found.


## Response 201 fields