users

Update a user

Changed on

Update user information

put/api/v1/users/{id}

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-API-Key
    • or API key in header Authorization

Path parameters

idstring required

User ID

Request body

activeboolean
emailstring
namestring
passwordstring
preferencesobject
profile_picturestring
role_namesstring[]

Response

OK

activeboolean
created_atstring
idstring
must_change_passwordboolean
namestring
preferencesobject
profile_picturestring
sessions_invalidated_atstring

Tokens issued before this moment are rejected at validation, so setting it to now signs the user out of every session at once.

updated_atstring
usernamestring

Changes