Bulk update groups

PATCH

/scim/v2/Groups/bulk

PATCH

/scim/v2/Groups/bulk

from zuora import ZuoraClient
from zuora.scim import PatchBulkPatchGroupsRequestOperationsItem, PatchBulkPatchGroupsRequestOperationsItemValueItem
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.scim.patch_bulk_patch_groups(
    schemas=[
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    operations=[
        PatchBulkPatchGroupsRequestOperationsItem(
            op="add",
            path="members",
            value=[
                PatchBulkPatchGroupsRequestOperationsItemValueItem(
                    value="e1b624ac-e00f-422b-b4da-20070901b22f",
                ),
                PatchBulkPatchGroupsRequestOperationsItemValueItem(
                    value="ea27634b-38ab-4592-86e4-2d4a140ae120",
                )
            ],
        )
    ],
)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "id": null,
  "externalId": null,
  "meta": null,
  "totalResults": 1,
  "resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:zuora:scim:schemas:1.0:GroupExtension"
      ],
      "id": "0fb99576-2154-4d96-a6cb-384dd430f45f",
      "displayName": "Amy Test",
      "members": [
        {
          "value": "e1b624ac-e00f-422b-b4da-20070901b22f",
          "display": "amy+test102"
        },
        {
          "value": "ea27634b-38ab-4592-86e4-2d4a140ae120",
          "display": "test01@zuora.com"
        }
      ],
      "urn:zuora:scim:schemas:1.0:GroupExtension": {
        "schemas": [
          "urn:zuora:scim:schemas:1.0:GroupExtension"
        ],
        "description": "Amy testing group",
        "organizationId": "5619df2e-fa8c-47fa-9c1e-16ab5af4936e",
        "active": true
      },
      "meta": {
        "resourceType": "Group",
        "location": "http://localhost:9900/scim/v2/Groups/bulk/0fb99576-2154-4d96-a6cb-384dd430f45f"
      }
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 1
}

Updates an existing group resource, allowing individual (or groups of) users to be added or removed from the group with a single operation.

Setting the operation attribute of a member object to delete will remove members from a group; add is the default operation for PATCH.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

schemaslist of stringsRequired

List of schema identifiers that define the format of the request.

operationslist of objectsRequired

List of operations to be performed on the resource.

Response headers

Content-EncodingstringOptional

RateLimit-LimitstringOptional

RateLimit-Remaininginteger

RateLimit-Resetinteger

Zuora-Request-IdstringOptional

Zuora-Track-IdstringOptional

Response

schemaslist of stringsOptional

List of schema identifiers that define the structure of the response.

idstring or nullOptional

externalIdstring or nullOptional

metaobject or nullOptional

Metadata about the group.

totalResultsintegerOptional

Total number of groups returned in the response.

resourceslist of objectsOptional

List of groups included in the response.

startIndexintegerOptional

itemsPerPageintegerOptional

Errors

401

Unauthorized Error

403

Forbidden Error