v14

latestOpenAPI 3.1.02026-08-043122950.3 KB

scim

Create a SCIM user

Creates a new user in the organization. If the user already exists, only active field will be updated to provision the user.

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

Path parameters

namestring required

Request body

schemasstring[] required

userNamestring required

Username for the user, it should respect the hub rules: No consecutive dashes, No digit-only, Does not start or end with a dash, Only dashes, letters or numbers, Not 24 chars hex string

activeboolean

externalIdstring required

External ID for the user, it must be unique within the organization and is required for managed users

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