Groups

Overview

The Groups endpoints enable querying of user group resources within the SCIM system. These APIs allow you to perform read operations on group entities. Authentication is required for all group operations.

Available Operations

List Groups

• Retrieve a paginated list of groups
• Supports filtering by group name
• Members are not returned by this endpoint

Get Group

• Retrieve detailed information about a specific group, including its members
• Access by unique group identifier (group name)

Common Group Attributes

• id: Unique identifier for the group (the group name, matched case-sensitively)
• displayName: Name of the group, same value as id
• description: Detailed description of the group's purpose
• members: List of users in the group, returned only when requesting a single group

For detailed API specifications, request/response examples, and implementation guidelines, please refer to the specific API endpoint documentation.

Note: Unlike the Users endpoints, the Groups API only supports read operations (GET). Create, Update, and Delete operations are not available through this API. Group membership is managed through the user-groups attribute on the Users endpoints.