scim

Update SCIM user

Changed on

Update an attribute of a SCIM user. Modify individual attributes using Operations format. Just provide the changes you want to make using add, remove (only externalId is supported), or replace operations. If you set active to false, the user will be deprovisioned from the organization. Complicated SCIM path values are not supported like emails[type eq 'work'].value.

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

Request

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

Path parameters

namestring required
userIdstring required

Request body

schemasstring[] required

Example request

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

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

  • bd17546f47b8Revision changes
    • breaking

      the // request property type changed from no type to string

    • breaking

      the / request property type changed from no type to string

    • 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