v14

latestOpenAPI 3.1.02026-08-043122950.3 KB

scim

Update a SCIM user

Updates a provisioned user, you'll need to provide all their information fresh - just like setting them up for the first time. Any details you don't include will be automatically removed, so make sure to include everything they need to keep their account running smoothly. Setting active to false will deprovision the user from the organization.

put/api/organizations/{name}/scim/v2/Users/{userId}

Path parameters

namestring required

userIdstring 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

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