Skip to main content
POST
Create a 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.

Body

SCIM core Group. A Plerion organization admin grants the group its roles in the console. A group maintained outside Plerion, by an identity provider sync or by calls to this API, is badged SCIM managed there; the badge does not stop this API from changing the group, but the next sync may overwrite the change.

schemas
string[]
required
Example:
displayName
string
required

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

externalId
string

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

members
object[]

Response

Group created.

SCIM core Group. A Plerion organization admin grants the group its roles in the console. A group maintained outside Plerion, by an identity provider sync or by calls to this API, is badged SCIM managed there; the badge does not stop this API from changing the group, but the next sync may overwrite the change.

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