curl --request PATCH \
--url https://{region}.api.plerion.com/v1/organization/scim/v2/Groups/{groupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/scim+json' \
--data '
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "Add",
"path": "members",
"value": [
{
"value": "0e8e8d5a-6a1b-4c1e-9f0d-2b7c8a9d3e4f"
}
]
}
]
}
'{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"displayName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"members": [
{
"value": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<unknown>",
"format": "<unknown>",
"readOnly": "<unknown>",
"display": "<string>"
}
],
"meta": {
"resourceType": "User",
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"version": "<string>",
"location": "<string>"
}
}{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidSyntax",
"detail": "A user with this userName already exists."
}{
"message": "Unauthorized"
}{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidSyntax",
"detail": "A user with this userName already exists."
}{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidSyntax",
"detail": "A user with this userName already exists."
}{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidSyntax",
"detail": "A user with this userName already exists."
}Partially update a group
add, remove, or replace operations on members and other writable attributes. A membership change takes effect on the member’s next request; nobody has to sign out.
curl --request PATCH \
--url https://{region}.api.plerion.com/v1/organization/scim/v2/Groups/{groupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/scim+json' \
--data '
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "Add",
"path": "members",
"value": [
{
"value": "0e8e8d5a-6a1b-4c1e-9f0d-2b7c8a9d3e4f"
}
]
}
]
}
'{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"displayName": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"members": [
{
"value": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<unknown>",
"format": "<unknown>",
"readOnly": "<unknown>",
"display": "<string>"
}
],
"meta": {
"resourceType": "User",
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"version": "<string>",
"location": "<string>"
}
}{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidSyntax",
"detail": "A user with this userName already exists."
}{
"message": "Unauthorized"
}{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidSyntax",
"detail": "A user with this userName already exists."
}{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidSyntax",
"detail": "A user with this userName already exists."
}{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidSyntax",
"detail": "A user with this userName already exists."
}Authorizations
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
The Plerion id of the user group, as returned when it was created.
Body
Response
The updated group.
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.
[
"urn:ietf:params:scim:schemas:core:2.0:Group"
]
Required. Shown as the user group's name in the Plerion console.
The identity provider's identifier for the group. Filterable.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?