Sign in
SCIM

List groups

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.

get/scim/v2/Groups

Query parameters

countinteger

The number of records returned per page in the response.

filterstring

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

startIndexinteger

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.

Headers

Content-Typestring required

The Content-Type of the request must be application/json.

Response

OK

schemasstring[]
idstring nullable
externalIdstring nullable
metaobject nullable
totalResultsinteger

Total numbers of groups present.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "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"
      }
    }
  ]
}

Changes