---
title: "Bulk create users"
method: POST
path: "/scim/v2/Users/bulk"
tags: ["SCIM"]
---

# Bulk create users

`POST /scim/v2/Users/bulk`

Creates multiple users within an organization.

## Request body

- object[]
  - `schemas` string[] — 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
    - `givenName` string — The given (or first) name of the user.
    - `familyName` string — The family (or last) name of the user.
    - `formatted` string — The full name of the user in a formatted string. Typically includes given name and family name.
  - `emails` object[]
    - `value` string — The email address of the user.
    - `type` string — The type of email address (e.g., 'work', 'home').
    - `primary` boolean — Indicates whether this email address is the user's primary email.
  - `roles` object[]
    - `value` string — The role assigned to the user, typically represented by an identifier.
    - `display` string, nullable
  - `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
    - `schemas` string[] — A list of schema URNs that describe additional extensions or custom schemas applied to the user resource.
    - `organizationId` string — An identifier for the organization to which the user belongs. This may be used for organizational or grouping purposes.

## Response `200`

OK

- object
  - `schemas` string[] — 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, nullable — A unique identifier for the response object, often used for referencing or tracking.
  - `externalId` string, nullable — 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` object[]
    - `schemas` string[] — A list of schema URNs that describe the structure of the individual user resource. These URNs indicate the schemas applicable to the user data.
    - `id` string, nullable — A unique identifier for the user resource.
    - `externalId` string, nullable — An external identifier for the resource, often used for integration with external systems.
    - `meta` object, nullable
      - `created` string, date-time — The date and time when the user resource was created, in ISO 8601 format.
      - `resourceType` string — The type of the resource, typically 'User' for user resources.
      - `location` string — The URL where the user resource can be accessed.
    - `userName` string — The username or login name for the user.
    - `name` object
      - `formatted` string — The full name of the user, formatted as a single string.
      - `familyName` string — The family (or last) name of the user.
      - `givenName` string — The given (or first) name of the user.
    - `displayName` string — The display name of the user, typically used for user identification.
    - `preferredLanguage` string — The user's preferred language, typically represented by a locale code (e.g., 'en', 'fr').
    - `locale` string — The user's locale, typically represented as a locale code (e.g., 'en-US', 'fr-FR').
    - `active` boolean — Indicates whether the user is currently active or not.
    - `emails` object[]
      - `value` string — The email address of the user.
      - `display` string — A display name or description for the email address.
      - `type` string — The type of email address (e.g., 'work', 'home').
      - `primary` boolean — Indicates whether this email address is the primary one for the user.
    - `roles` object[]
      - `value` string — The role assigned to the user, often represented by an identifier.
      - `display` string, nullable
    - `urn:zuora:scim:schemas:1.0:UserExtension` object
      - `schemas` string[] — A list of schema URNs that describe additional extensions or custom schemas applied to the user resource.
      - `organizationId` string, uuid — An identifier for the organization to which the user belongs. This may be used for organizational or grouping purposes.
      - `status` string — The current status of the user. Example values might include 'NEW', 'ACTIVE', 'INACTIVE', etc.
      - `ssoEnabled` boolean — Indicates whether Single Sign-On (SSO) is enabled for the user.
      - `region` string
  - `startIndex` integer
  - `itemsPerPage` integer

## Other responses

- `201` — Created
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)