Bulk delete groups

POST

/scim/v2/Groups/delete

POST

/scim/v2/Groups/delete

from zuora import ZuoraClient
from zuora.scim import PostBulkDeleteGroupsRequestOperationsItem, PostBulkDeleteGroupsRequestOperationsItemValueItem
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.scim.post_bulk_delete_groups(
    schemas=[
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    operations=[
        PostBulkDeleteGroupsRequestOperationsItem(
            op="add",
            path="members",
            value=[
                PostBulkDeleteGroupsRequestOperationsItemValueItem(
                    value="71d3c0ec-48db-4522-b5c9-053e051204d7",
                ),
                PostBulkDeleteGroupsRequestOperationsItemValueItem(
                    value="62c20400-6470-4992-8a01-c181efc2ce54",
                )
            ],
        )
    ],
)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "id": null,
  "externalId": null,
  "meta": null,
  "totalResults": 2,
  "resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:zuora:scim:schemas:1.0:GroupExtension"
      ],
      "id": "71d3c0ec-48db-4522-b5c9-053e051204d7",
      "displayName": "test_group_22",
      "urn:zuora:scim:schemas:1.0:GroupExtension": {
        "description": "",
        "organizationId": "5619df2e-fa8c-47fa-9c1e-16ab5af4936e",
        "active": false,
        "schemas": [
          "urn:zuora:scim:schemas:1.0:GroupExtension"
        ]
      },
      "meta": {
        "resourceType": "Group",
        "location": "http://localhost:9900/scim/v2/Groups/delete/71d3c0ec-48db-4522-b5c9-053e051204d7"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:zuora:scim:schemas:1.0:GroupExtension"
      ],
      "id": "62c20400-6470-4992-8a01-c181efc2ce54",
      "displayName": "test_group_11",
      "urn:zuora:scim:schemas:1.0:GroupExtension": {
        "description": "",
        "organizationId": "5619df2e-fa8c-47fa-9c1e-16ab5af4936e",
        "active": false,
        "schemas": [
          "urn:zuora:scim:schemas:1.0:GroupExtension"
        ]
      },
      "meta": {
        "resourceType": "Group",
        "location": "http://localhost:9900/scim/v2/Groups/delete/62c20400-6470-4992-8a01-c181efc2ce54"
      }
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 2
}

Permanently removes groups from an organization (members are not deleted, only the group).

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

schemaslist of stringsRequired

operationslist of objectsRequired

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

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

metaobject or nullOptional

Metadata about the group resource.

totalResultsintegerOptional

Total number of groups returned in the response.

resourceslist of objectsOptional

List of group resources included in the response.

startIndexintegerOptional

itemsPerPageintegerOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Authentication

Headers

Request

Response headers

Response

Errors