{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"displayName": "Platform Engineering",
"members": [{"value": "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
Update a SCIM group
Fully replaces a SCIM group’s display name and member list.
Required scopes: user_management:read-write.
PUT
/
scim
/
v2
/
Groups
/
{workspace_team_id}
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"displayName": "Platform Engineering",
"members": [{"value": "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
string
required
This API uses OAuth 2.0 with the authorization code grant flow.
Path
string
required
The ID of the group to update.
Body
application/jsonstring[]
required
Must include
"urn:ietf:params:scim:schemas:core:2.0:Group".string
required
The new display name for the group. Must be non-empty after trimming whitespace. Must be unique within the workspace.
object[]
required
Response
string[]
Always
["urn:ietf:params:scim:schemas:core:2.0:Group"].string
The unique ID of the group.
string
The updated display name of the group.
object[]
object
{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
"displayName": "Platform Engineering",
"members": [{"value": "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