Skip to main content
GET
Get one group

Authorizations

Authorization
string
header
required

Plerion organization API key (plerion_oak_…), created by an organization admin in the Plerion console. Write operations require a key with readWrite access level; GET and .search work with read access level.

Path Parameters

groupId
string<uuid>
required

The Plerion id of the user group, as returned when it was created.

Query Parameters

attributes
string

Comma-separated attribute paths to include in the response.

excludedAttributes
string

Comma-separated attribute paths to omit from the response.

Response

The group.

SCIM core Group. The identity provider owns the name and the members; a Plerion organization admin grants the group its roles in the console.

schemas
string[]
required
Example:
displayName
string
required

Required. Shown as the user group's name in the Plerion console.

id
string<uuid>
read-only
externalId
string

The identity provider's identifier for the group. Filterable.

members
object[]
meta
object
read-only