Get all Groups
List all groups in your tenant.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter groups by connection ID.
Filter groups by name.
1 - 128Filter groups by external ID.
256Search for groups by name or external ID.
1 - 256A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
256Whether specified fields are to be included (true) or excluded (false).
Page index of the results to return. First page is 0. Offset-based pagination is limited to a maximum of 1,000 results; use checkpoint pagination (from and take) instead.
x >= 0Number of results per page. Defaults to 50. Offset-based pagination is limited to a maximum of 1,000 results; use checkpoint pagination (from and take) instead.
1 <= x <= 100Return results inside an object that contains the total result count (true) or as a direct array of results (false, default). The returned total reflects at most 1,000 results.
Optional Id from which to start selection.
Number of results per page. Defaults to 50.
1 <= x <= 100Response
Groups successfully retrieved.
- object[]
- object
Represents the metadata of a group. Member lists are retrieved via a separate endpoint.
Unique identifier for the group (service-generated).
18 - 26^grp_[1-9a-km-zA-HJ-NP-Z]{14,22}$Name of the group. Must be unique within its connection. Must contain between 1 and 128 printable ASCII characters.
1 - 128^[\x20-\x7E]+$External identifier for the group, often used for SCIM synchronization. Max length of 256 characters.
256Identifier for the connection this group belongs to (if a connection group).
Identifier for the tenant this group belongs to.
3^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$Timestamp of when the group was created.
Timestamp of when the group was last updated.