v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Groups

Get Group

Use this endpoint to retrieve a specific group by its ID.

get/Groups/{id}

Path parameters

idinteger required

The unique ID of the SCIM resource.

Query parameters

attributesstring

When included, each resource returned will contain the minimum set of resource attributes and any attributes or sub-attributes explicitly requested.

excludedAttributesstring

When included, each resource returned will contain the minimum set of resource attributes. Additionally, the default set of attributes minus those attributes listed in "excludedAttributes" is returned.

Response

Returns the requested group, optionally filtered by values in attributes or excludedAttributes parameters.

displayNamestring

A human-readable name for the Group.

externalIdstring nullable

A custom, user-supplied ID.

idstring

The ID of this resource instance.

schemasstring[]

A schema for representing the group's configuration.