Update a Group

Update an existing Group by adding or removing members.

PATCH

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

Headers

Key	Value
Content-Type	application/json
Authorization	Bearer <API Token>

Path Parameter

• id (required): Group ID to update the specific group.

Request Body

The request body must contain an array of members to add or remove from the group.

{
    "members": [
        {
            "value": 3,
            "display": "user3@example.com"
        },
        {
            "value": 4,
            "display": "user4@example.com"
        }
    ]
}

Example cURL

curl --location --request PATCH 'http://localhost:8080/api/scim/v2/Groups/group-123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
--data-raw '{
    "members": [
        {
            "value": 3,
            "display": "user3@example.com"
        },
        {
            "value": 4,
            "display": "user4@example.com"
        }
    ]
}'

Responses

Status Code	Description
200	Group updated successfully
400	Internal server error
401	Unauthorized
500	Internal Server Error

Sample response

200 : Group created successfully

{
    "id": "123",
    "displayName": "Developers",
    "members": [
        {
            "value": 1,
            "display": "user1@example.com"
        },
        {
            "value": 2,
            "display": "user2@example.com"
        }
    ],
    "meta": {
        "location": "http://localhost:8080/api/scim/v2/Groups/123",
        "created": "2023-08-04T08:38:02.3732123Z"
    }
}