BEbeyondidentity
SCIM

Retrieve an existing group

To retrieve an existing group, send a GET request to /Groups/$GROUP_ID. The response will contain a full representation of the Group resource matching the specified identifier. Per RFC-7644 §3.4.1, the server will respond with HTTP status 200 and the resource if found, or 404 if not found.

Note that this method can be used to retrieve RBAC permission groups as well as other groups created through the Admin Console.

get/scim/v2/Groups/{group_id}

Request

Path parameters

group_idstring required

ID of the group.

Response

Successfully returns the requested Group resource. As per RFC-7643 §4.2, the response includes:

  • schemas: Array of schema identifiers
  • id: Unique identifier for the Group
  • displayName: Human-readable name of the Group
  • members: Array of Group members (if any)
  • meta: Resource metadata (lastModified, created, etc.)
schemasstring[] required

The list of schemas used to define the group. This must contain the core Group schema ("urn:ietf:params:scim:schemas:core:2.0:Group") and may include the custom Beyond Identity Group schema extension ("urn:scim:schemas:extension:byndid:1.0:Group").

idstring required

The unique ID of the group. This is automatically generated on creation. This field is immutable and output-only.

displayNamestring required

The unique display name of the group. This name is used for display purposes.

metaMeta required(unresolved $ref)

Changes

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