v13

OpenAPI 3.1.02026-08-033122950.3 KB

scim

List SCIM groups

Get a list of SCIM groups. Retrieves a paginated list of all organization groups. If you provide the filter parameter, the resources for all matching groups are returned.

get/api/organizations/{name}/scim/v2/Groups

Path parameters

namestring required

Query parameters

startIndexnumber

countnumber

filterstring

excludedAttributes'members'

Response

SCIM Group List

schemasstring[] required

totalResultsinteger required

itemsPerPageinteger required

startIndexinteger required

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 100,
  "itemsPerPage": 100,
  "startIndex": 1,
  "Resources": [
    {
      "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"
      }
    }
  ]
}