Modify group membership

PATCH /Groups/{groupId}

Modify group members using SCIM PATCH operations

Path parameters

groupId string Required

Identifier of the group to modify

application/json

Body Required

schemas array[string] Required

Value is urn:ietf:params:scim:api:messages:2.0:PatchOp.
Operations array[object] Required
Hide Operations attributes Show Operations attributes object
- op string Required
  
  Values are add, remove, or replace.
- path string Required
- value array[object]
  Hide value attribute Show value attribute object
  
  value string

Responses

204

Operation successful

PATCH /Groups/{groupId}

curl --request PATCH \
  --url 'https://setup.adra.com/api/organizations/your-org-id/scim/Groups/group-id' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [{
    "op": "add",
    "path": "members",
    "value": [{ "value": "user-id" }]
  }]
}'

curl --request PATCH \
  --url 'https://setup.adra.com/api/organizations/your-org-id/scim/Groups/group-id' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [{
    "op": "remove",
    "path": "members",
    "value": [{ "value": "user-id" }]
  }]
}'

Request examples

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

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "remove",
      "path": "members",
      "value": [
        {
          "value": "user-id-123"
        }
      ]
    }
  ]
}

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

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "replace",
      "path": "members",
      "value": [
        {
          "value": "user-id-1"
        },
        {
          "value": "user-id-2"
        }
      ]
    }
  ]
}