Skip to main content
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: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

​
Authorization
string
required
This API uses OAuth 2.0 with the authorization code grant flow.

​
Path

​
workspace_team_id
string
required
The ID of the group to update.

Body

application/json
​
schemas
string[]
required
Must include "urn:ietf:params:scim:api:messages:2.0:PatchOp".
​
Operations
object[]
required
List of patch operations to apply sequentially.

​
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: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"
  }
}