{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "add",
"path": "members",
"value": [{"value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"}]
}
]
}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "replace",
"path": "displayName",
"value": "Platform Engineering"
}
]
}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "remove",
"path": "members"
}
]
}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "remove",
"path": "members[value eq \"3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47\"]"
}
]
}
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
"displayName": "Platform Engineering",
"members": [
{
"value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
"$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
}
],
"meta": {
"resourceType": "Group",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-02T00:00:00.000Z"
}
}
Groups
Patch a SCIM group
Applies partial updates to a SCIM group using SCIM PatchOp operations. Supports updating the display name and adding, removing, or replacing members.
Required scopes: user_management:read-write.
PATCH
/
scim
/
v2
/
Groups
/
{workspace_team_id}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "add",
"path": "members",
"value": [{"value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"}]
}
]
}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "replace",
"path": "displayName",
"value": "Platform Engineering"
}
]
}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "remove",
"path": "members"
}
]
}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "remove",
"path": "members[value eq \"3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47\"]"
}
]
}
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
"displayName": "Platform Engineering",
"members": [
{
"value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
"$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
}
],
"meta": {
"resourceType": "Group",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-02T00:00:00.000Z"
}
}
Authorizations
This API uses OAuth 2.0 with the authorization code grant flow.
Path
The ID of the group to update.
Body
application/jsonMust include
"urn:ietf:params:scim:api:messages:2.0:PatchOp".List of patch operations to apply sequentially.
Show Operations[]
Show Operations[]
The operation type:
"add", "remove", or "replace".The attribute to target, e.g.
"displayName" or "members". Also supports the SCIM filter path syntax members[value eq "{id}"] with op: "remove" to remove a specific member. May be omitted when value contains a keyed object.The value for the operation. For member additions and replacements, must be an array of objects with a
value property containing a workspace membership ID or workspace invite ID.Response
The response has the same shape as Update a SCIM group.{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "add",
"path": "members",
"value": [{"value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"}]
}
]
}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "replace",
"path": "displayName",
"value": "Platform Engineering"
}
]
}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "remove",
"path": "members"
}
]
}
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
"Operations": [
{
"op": "remove",
"path": "members[value eq \"3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47\"]"
}
]
}
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
"displayName": "Platform Engineering",
"members": [
{
"value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
"$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
}
],
"meta": {
"resourceType": "Group",
"created": "2024-01-01T00:00:00.000Z",
"lastModified": "2024-01-02T00:00:00.000Z"
}
}
Was this page helpful?
⌘I