Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Users

Update a user with the given id

Updates a user's name and permissions.

put/users/{user_id}

Path parameters

user_idinteger required
Example:508

Id of user

Request body

first_namestring

First name of the user.

last_namestring

Last name of the user.

is_administratorboolean

If this user is an administrator. Administrators always have access to all dashboards, as well as the ability to change all settings for an account.

external_user_idstring

The external id of the user. The external id is only used as part of the api to label users for filtering and searching. Multiple users can have the same external id.

Example request

{
  "first_name": "John",
  "last_name": "Doe",
  "external_user_id": "johndoe_1",
  "permissions": [
    {
      "dashboard_id": 121,
      "role": "manager"
    }
  ]
}

Response

The user was updated.

idinteger

The user identifier. Required to update or delete users.

first_namestring

First name of the user.

last_namestring

Last name of the user.

is_administratorboolean

If this user is an administrator. Administrators always have access to all dashboards, as well as the ability to change all settings for an account.

emailstring

Email address of the user. The email address functions as the user's username.

external_user_idstring

The external id of the user. The external id is only used as part of the api to label users for filtering and searching. Multiple users can have the same external id.

Example response

{
  "id": 508,
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@wefixwindows.com",
  "external_user_id": "johndoe_1",
  "permissions": [
    {
      "dashboard_id": 121,
      "role": "manager"
    }
  ]
}