Patch group

Partially updates a group’s attributes (e.g., add or remove members).

PATCH /api/v1/scim/v2/Groups/{id}

Error

A valid request URL is required to generate request examples

200

{
  "schemas": [
    "<string>"
  ],
  "id": "<string>",
  "meta": {
    "location": "<string>",
    "lastModified": "2023-11-07T05:31:56Z",
    "created": "2023-11-07T05:31:56Z",
    "resourceType": "Group",
    "version": "<string>"
  },
  "displayName": "<string>",
  "members": [
    {
      "value": "<string>",
      "display": "<string>"
    }
  ]
}

Path Parameters

id · string · required

SCIM ID of the group to update

Body

application/json

Update operations to apply to the group

Update operations to apply to the group

schemas · enum<string>[] · required

Available options: urn:ietf:params:scim:api:messages:2.0:PatchOp

Operations · object[] · required

Option 1

Option 2

Show child attributes

Operations. op · enum<string> · required

Available options: remove, Remove

Operations. path · string · required

Operations. value · any

Response

200

application/json

Ok

schemas · string[] · required

id · string · required

meta · object · required

Show child attributes

meta. location · string · required

meta. lastModified · string<date-time> · required

meta. created · string<date-time> · required

meta. resourceType · enum<string> · required

Available options: Group

meta. version · string

displayName · string · required

members · object[]

Show child attributes

members. value · string · required

members. display · string