v13

latestOpenAPI 3.1.02026-08-033122950.3 KB
scim

Update SCIM group

Update attributes of a SCIM group. Updates individual attributes using Operations format. Just provide the changes you want to make using add, remove (only members is supported), or replace operations.

patch/api/organizations/{name}/scim/v2/Groups/{groupId}

Path parameters

namestring required
groupIdstring required

Request body

schemasstring[] required

Example request

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

Response

SCIM Group

schemasstring[] required
idstring required
displayNamestring required
externalIdstring nullable

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "123",
  "displayName": "Group 1",
  "members": [
    {
      "value": "john"
    }
  ],
  "externalId": "unique-identifier",
  "meta": {
    "resourceType": "Group",
    "location": "https://huggingface.co/api/organizations/:name/scim/v2/Groups/:id"
  }
}