Skip to main content
PATCH
Partially update 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.

Path Parameters

groupId
string<uuid>
required

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

Body

RFC 7644 PatchOp. op values are matched case-insensitively.

schemas
string[]
required
Allowed value: "urn:ietf:params:scim:api:messages:2.0:PatchOp"
Operations
object[]
required
Minimum array length: 1

Response

The updated 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