Bulk update users

PATCH

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

PATCH

/scim/v2/Users/bulk

from zuora import ZuoraClient
from zuora.scim import BulkUpdateUsersRequestItem
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.scim.bulk_update_users(
    request=[
        BulkUpdateUsersRequestItem()
    ],
)

{
  "itemsPerPage": 2,
  "startIndex": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "id": null,
  "externalId": null,
  "meta": null,
  "totalResults": 2,
  "resources": [
    {
      "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": "updated2@example.com",
          "display": "updated2@example.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": "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": "updated3@example.com",
          "display": "updated3@example.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"
      }
    }
  ]
}

Updates an existing multiple user resource, overwriting values for specified attributes.

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 apply to this resource, indicating the structure and attributes of the resource.

idstringOptional

A unique identifier for the resource within the system.

externalIdstringOptional

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

metaobjectOptional

userNamestringOptional

The username of the user. This is typically a unique identifier for the user within the system.

nameobjectOptional

displayNamestringOptional

A name that is suitable for display to end-users, which may be different from the username or full name.

preferredLanguagestringOptional

The preferred language of the user for communication and content.

localestringOptional

The locale of the user, typically used to determine regional settings (e.g., ‘en-US’ for English, United States).

activebooleanOptional

Indicates whether the user account is currently active. A value of true means the account is active, and false means it is inactive.

emailslist of objectsOptional

roleslist of objectsOptional

urn:zuora:scim:schemas:1.0:UserExtensionobjectOptional

Response

itemsPerPageintegerOptional

The items that are allowed on each page.

startIndexintegerOptional

schemaslist of stringsOptional

A list of schema URNs that apply to this resource, indicating the structure and attributes of the response.

idstring or nullOptional

A unique identifier for the response resource, typically the ID of the user or group.

externalIdstring or nullOptional

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

metaobject or nullOptional

totalResultsintegerOptional

The total number of results returned by the request. This helps in pagination and determining the total size of the dataset.

resourceslist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error