scim

Get SCIM group

Changed on

Retrieves a group by its ID. If you provide the excludedAttributes parameter, the members attribute is not returned.

get/api/organizations/{name}/scim-provisioning/v2/Groups/{groupId}

Request

  • Base URL: https://huggingface.co
  • URL: https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Groups/{groupId}
  • Auth: HTTP bearer

Path parameters

namestring required
groupIdstring required

Query parameters

excludedAttributes'members'

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"
  }
}

Changes

  • bd17546f47b8Revision changes
    • breaking

      the / response's property type changed from no type to string for status

    • breaking

      the / response's property type changed from no type to string for status

    • info

      for the query request parameter excludedAttributes, the type was generalized from no type to string