List groups

GET

/scim/v2/Groups

GET

/scim/v2/Groups

from zuora import ZuoraClient
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.scim.get_list_groups()

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "id": null,
  "externalId": null,
  "meta": null,
  "totalResults": 28,
  "resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:zuora:scim:schemas:1.0:GroupExtension"
      ],
      "id": "01b496f7-1988-44aa-9ea6-c27f0288fa9d",
      "displayName": "Test_GroupName",
      "members": [
        {
          "value": "e1b624ac-e00f-422b-b4da-20070901b22f"
        }
      ],
      "urn:zuora:scim:schemas:1.0:GroupExtension": {
        "schemas": [
          "urn:zuora:scim:schemas:1.0:GroupExtension"
        ],
        "description": "Test_GroupDescription",
        "organizationId": "5619df2e-fa8c-47fa-9c1e-16ab5af4936e",
        "active": true
      },
      "meta": {
        "resourceType": "Group",
        "location": "http://localhost:9900/scim/v2/Groups/01b496f7-1988-44aa-9ea6-c27f0288fa9d"
      }
    }
  ]
}

Returns a paginated list of groups, ten groups per page by default. Use the startIndex and count (max 100) query parameters to paginate long lists of groups. It’s possible to return a list of specific types of groups using the filter parameter.

Authentication

AuthorizationBearer

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

Query parameters

countintegerOptional

The number of records returned per page in the response.

filterstringOptional

The filter used to filter the group, either by organization id.

startIndexintegerOptional

The index number of the page that you want to retrieve. You must set count before specifying startIndex. For example, if you set count to 20 and startIndex to 2, the 21st to 40th records are returned in the response.

Response headers

Content-EncodingstringOptional

RateLimit-LimitstringOptional

RateLimit-Remaininginteger

RateLimit-Resetinteger

Zuora-Request-IdstringOptional

Zuora-Track-IdstringOptional

Response

schemaslist of stringsOptional

idstring or nullOptional

externalIdstring or nullOptional

metaobject or nullOptional

totalResultsintegerOptional

Total numbers of groups present.

resourceslist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error