BEbeyondidentity
SCIM

List All Groups

Retrieves a list of SCIM Group resources that match the specified filter criteria. Send a GET request to /Groups.

Note that this method includes the RBAC access groups as well as groups created through the Admin Console.

Filtering (RFC-7644 §3.4.2.2):

  • Supports 'eq' (equals) and 'ne' (not equals) operators
  • Filterable attributes: displayName
  • Example: filter=displayName eq "Engineering"

Pagination (RFC-7644 §3.4.2.4):

  • Use startIndex (1-based) and count parameters
  • Maximum page size: 1000 items
  • If count is not specified or is zero, no resources will be returned
  • Response includes totalResults for determining additional pages

Sorting:

  • No sorting parameters are supported; response order is undefined
get/scim/v2/Groups

Request

Query parameters

filterstring
Example:displayName eq "John Doe"

Filter for list methods.

Filters follow the SCIM grammar from RFC 7644 Section 3.4.2.2.

countinteger

Specifies the desired maximum number of query results per page. A negative value is treated as 0, which indicates that the response should not contain any resources. Note that the response may include fewer results than the requested count.

startIndexinteger

The 1-based index of the first query result.

Response

Successfully returns a ListResponse containing the requested Groups. As per RFC-7644 §3.4.2, the response includes: - schemas: List of response schema URNs - totalResults: Total number of results matching the query - Resources: Array of Group objects matching query criteria - startIndex: Starting index of results (1-based) - itemsPerPage: Number of results returned

schemasstring[] required

The list of schemas used to define the list response. This only contains the ListResponse schema ("urn:ietf:params:scim:api:messages:2.0:ListResponse").

totalResultsinteger required

Total number of results matching the request. This value may be larger than the number of resources returned, such as when returning a single page of results where multiple pages are available.

startIndexinteger required

The 1-based index of the first result in the current set of list results.

itemsPerPageinteger required

The number of resources returned in a list response page.

Changes

No recorded changes to this operation across all 1 revision of this API.