scim

Create SCIM invitation

Changed on

Creates an invitation for a user to join the organization. The user must have an existing Hugging Face account.

post/api/organizations/{name}/scim-provisioning/v2/Users

Request

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

Path parameters

namestring required

Request body

schemasstring[] required
userNamestring required

IdP username. Ignored: the user is matched by confirmed email

activeboolean
externalIdstring required

SSO unique identifier (SAML nameid or OIDC sub claim) - required for SSO login

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ]
}

Response

SCIM User

schemasstring[] required
idstring required
externalIdstring nullable required
userNamestring required
displayNamestring required
activeboolean required

Example response

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

  • 2e368d71e0f0Revision changes
    • info

      the request property's minLength was decreased from 2 to 0

    • info

      removed the pattern ^\b(?!\d+$)(?![0-9a-fA-F]{24}$)([a-zA-Z0-9]|-(?!-))+\b$ from the request property

  • 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