Bulk create users

POST

https://one.zuora.com/scim/v2/Users/bulk

POST

/scim/v2/Users/bulk

from zuora import ZuoraClient
from zuora.scim import BulkCreateUsersRequestItem, BulkCreateUsersRequestItemName, BulkCreateUsersRequestItemEmailsItem, BulkCreateUsersRequestItemRolesItem, BulkCreateUsersRequestItemUrnZuoraScimSchemas10UserExtension
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.scim.bulk_create_users(
    request=[
        BulkCreateUsersRequestItem(
            schemas=[
                "urn:zuora:scim:schemas:1.0:UserExtension",
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            name=BulkCreateUsersRequestItemName(
                given_name="Amy",
                family_name="Lawrence",
                formatted="Amy Lawrence",
            ),
            emails=[
                BulkCreateUsersRequestItemEmailsItem(
                    value="Amy+test3@zuora.com",
                    type="work",
                    primary=True,
                )
            ],
            roles=[
                BulkCreateUsersRequestItemRolesItem(
                    value="USER",
                )
            ],
            user_name="Amy+test3@zuora.com",
            preferred_language="en",
            locale="en-US",
            urn_zuora_scim_schemas10user_extension=BulkCreateUsersRequestItemUrnZuoraScimSchemas10UserExtension(
                schemas=[
                    "urn:zuora:scim:schemas:1.0:UserExtension"
                ],
                organization_id="ec141dc2-901e-4813-a25d-ef480cff1e26",
            ),
        ),
        BulkCreateUsersRequestItem(
            schemas=[
                "urn:zuora:scim:schemas:1.0:UserExtension",
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            name=BulkCreateUsersRequestItemName(
                given_name="Amy",
                family_name="Lawrence",
                formatted="Amy Lawrence",
            ),
            emails=[
                BulkCreateUsersRequestItemEmailsItem(
                    value="Amy+test4@zuora.com",
                    type="work",
                    primary=True,
                )
            ],
            roles=[
                BulkCreateUsersRequestItemRolesItem(
                    value="USER",
                )
            ],
            user_name="Amy+test4@zuora.com",
            preferred_language="en",
            locale="en-US",
            urn_zuora_scim_schemas10user_extension=BulkCreateUsersRequestItemUrnZuoraScimSchemas10UserExtension(
                schemas=[
                    "urn:zuora:scim:schemas:1.0:UserExtension"
                ],
                organization_id="ec141dc2-901e-4813-a25d-ef480cff1e26",
            ),
        )
    ],
)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "id": null,
  "externalId": null,
  "totalResults": 2,
  "resources": [
    {
      "schemas": [
        "urn:zuora:scim:schemas:1.0:UserExtension",
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "8b40ccce-5fb7-4643-9b78-e194fe5303e6",
      "externalId": "Amy+test3@zuora.com",
      "meta": {
        "created": "2024-10-03T09:37:39.851Z",
        "resourceType": "User",
        "location": "http://localhost:9900/scim/v2/Users/bulk/8b40ccce-5fb7-4643-9b78-e194fe5303e6"
      },
      "userName": "Amy+test3@zuora.com",
      "name": {
        "formatted": "Amy Lawrence",
        "familyName": "Amy",
        "givenName": "Lawrence"
      },
      "displayName": "Amy Lawrence",
      "preferredLanguage": "en",
      "locale": "en-US",
      "active": true,
      "emails": [
        {
          "value": "Amy+test3@zuora.com",
          "display": "Amy+test3@zuora.com",
          "type": "work",
          "primary": true
        }
      ],
      "roles": [
        {
          "value": "USER",
          "display": "USER"
        }
      ],
      "urn:zuora:scim:schemas:1.0:UserExtension": {
        "schemas": [
          "urn:zuora:scim:schemas:1.0:UserExtension"
        ],
        "organizationId": "5619df2e-fa8c-47fa-9c1e-16ab5af4936e",
        "status": "ACTIVE",
        "ssoEnabled": true,
        "region": "EU"
      }
    },
    {
      "schemas": [
        "urn:zuora:scim:schemas:1.0:UserExtension",
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "41aa4e47-01e2-4d85-a6bc-d88e18477011",
      "externalId": "Amy+test4@zuora.com",
      "meta": {
        "created": "2024-10-03T09:37:40.161Z",
        "resourceType": "User",
        "location": "http://localhost:9900/scim/v2/Users/bulk/41aa4e47-01e2-4d85-a6bc-d88e18477011"
      },
      "userName": "Amy+test4@zuora.com",
      "name": {
        "formatted": "Amy Lawrence",
        "familyName": "Amy",
        "givenName": "Lawrence"
      },
      "displayName": "Amy Lawrence",
      "preferredLanguage": "en",
      "locale": "en-US",
      "active": true,
      "emails": [
        {
          "value": "Amy+test4@zuora.com",
          "display": "Amy+test4@zuora.com",
          "type": "work",
          "primary": true
        }
      ],
      "roles": [
        {
          "value": "USER",
          "display": "USER"
        }
      ],
      "urn:zuora:scim:schemas:1.0:UserExtension": {
        "schemas": [
          "urn:zuora:scim:schemas:1.0:UserExtension"
        ],
        "organizationId": "5619df2e-fa8c-47fa-9c1e-16ab5af4936e",
        "status": "ACTIVE",
        "ssoEnabled": true,
        "region": "EU"
      }
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 2,
  "meta": null
}

Creates multiple users within an organization.

Authentication

AuthorizationBearer

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

Request

This endpoint expects a list of objects.

schemaslist of stringsOptional

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.

nameobjectOptional

emailslist of objectsOptional

roleslist of objectsOptional

userNamestringOptional

The username or login name of the user.

preferredLanguagestringOptional

The preferred language of the user, typically represented by a locale code (e.g., ‘en’, ‘fr’).

localestringOptional

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

urn:zuora:scim:schemas:1.0:UserExtensionobjectOptional

Response

schemaslist of stringsOptional

A list of schema URNs that describe the structure of the response. These URNs indicate the schemas that are applicable to the data.

idstring or nullOptional

A unique identifier for the response object, often used for referencing or tracking.

externalIdstring or nullOptional

An external identifier for the resource, often used for integration with external systems.

totalResultsintegerOptional

The total number of user resources available in the response, irrespective of pagination.

resourceslist of objectsOptional

startIndexintegerOptional

itemsPerPageintegerOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error