scim

List SCIM users

Changed on

Retrieves a paginated list of all organization members who have been set up, including disabled users. If you provide the filter parameter, the resources for all matching members are returned.

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

Request

  • Base URL: https://huggingface.co
  • URL: https://huggingface.co/api/organizations/{name}/scim/v2/Users
  • Auth: HTTP bearer

Path parameters

namestring required

Query parameters

startIndexnumber
countnumber
filterstring

You can filter results using the equals operator (eq) to find items that match specific values like id, userName, emails, and externalId. For example, to find a user named Bob, use this search: ?filter=userName%20eq%20Bob

Response

SCIM User 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:User"
      ],
      "id": "123",
      "externalId": "unique-identifier",
      "userName": "username",
      "displayName": "username (equals to userName)",
      "name": {
        "givenName": "John",
        "familyName": "Doe",
        "formatted": "John Doe"
      },
      "emails": [
        {
          "value": "john.doe@example.com",
          "primary": true,
          "type": "work"
        }
      ],
      "active": true,
      "meta": {
        "resourceType": "User",
        "location": "https://huggingface.co/api/organizations/:name/scim/v2/Users/: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

    • 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