Get SCIM groups collection

get/scim/v2/Groups

Returns a collection of groups. Standard paging, filtering options are provided.

Request Samples

1

Response Samples

1{
2  "schemas": [
3    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
4  ],
5  "startIndex": 1,
6  "itemsPerPage": 1,
7  "totalResults": 1,
8  "Resources": [
9    {
10      "id": "e2c9c521-6b7c-49d2-8fff-7a3df8c03cf4",
11      "displayName": "TestScimGroup1",
12      "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
13      "schemas": [
14        "urn:ietf:params:scim:schemas:core:2.0:Group"
15      ],
16      "meta": {
17        "resourceType": "Group",
18        "created": "2025-10-16T13:50:44.645Z",
19        "lastModified": "2025-10-16T13:50:44.645Z"
20      }
21    }
22  ]
23}

Query Parameters

NameTypeRequiredDescription
attributes
string
false

A comma-separated list of attribute names to return in the response.

count
integer<int32>
false

Maximum number of groups to return in this page of results. The actual number of returned groups can be less if the collection has been exhausted. Defaults to 10.

>= 0
excludedAttributes
string
false

A comma-separated list of attribute names to exclude from the response.

filter
string<filter-criteria>
false

Filter criteria for returned groups. See SCIM Filtering for syntax details.

startIndex
integer<int32>
false

The starting index of the first group in a page. Defaults to 1.

>= 1

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

An invalid filter or combination of request parameters was provided.

401Unauthorized

Authentication is required.

403Forbidden

The authenticated user does not have sufficient privileges.

Schema