PATCH | Modify Group Membership

  • 1 minute(s) read
Prev Next

Endpoint: PATCH {{senhasegura_url}}/iso/scim/v2/Groups/{group_id}

Description: performs partial modifications to group configuration, primarily focused on member management operations using SCIM PATCH operation syntax.

Request Parameters

  • Method: PATCH
  • Path Parameter: group_id (required).
    • Target group identifier.
  • Content-Type: application/json.
  • Authorization: Bearer token required.

Request Body Structure

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
          "value": "string"
        }
      ]
    }
  ]
}

Request Elements

Element Description
schemas SCIM PATCH operation schema identifier.
Operations Array of modification operations.
op Operation type (add, remove, replace).
path Target attribute path for modification.
value New value or array of values to apply.

Supported Operations

Operation Description
Add Members Add new users to group membership.
Remove Members Remove existing users from the group.
Replace Members Replace entire member list.

Status Codes

Status Code Description
200 OK Successful group modification with updated data.
204 No Content Successful modification without response body.
400 Bad Request Invalid PATCH operation syntax.
404 Not Found Target group does not exist.
401 Unauthorized Invalid or missing authentication token.