Sign in
SCIM

Bulk delete groups

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

post/scim/v2/Groups/delete

Headers

Idempotency-Keystring

Specify a unique idempotency key to ensure that a POST or PATCH request is idempotent. Do not use this header for other request types.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids-Singlestring

Request body

schemasstring[] required

Response

OK

schemasstring[]

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

idstring nullable
externalIdstring nullable

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

totalResultsinteger

Total number of groups returned in the response.

startIndexinteger
itemsPerPageinteger

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "meta": {
    "resourceType": "Group"
  },
  "totalResults": 2,
  "resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:zuora:scim:schemas:1.0:GroupExtension"
      ],
      "id": "5aa8a1fe-4ed4-44db-a6ae-78645a20ae21",
      "displayName": "test_group_1",
      "urn:zuora:scim:schemas:1.0:GroupExtension": {
        "organizationId": "ec141dc2-901e-4813-a25d-ef480cff1e26",
        "active": true
      },
      "meta": {
        "resourceType": "Group"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.