users

Update a user by user ID

Update a user with the provided values. You cannot update a user's Plex token through this request.

Requires the MANAGE_USERS permission.

put/user/{userId}

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/user/{userId}
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Path parameters

userIdnumber required

Request body

idinteger required
emailstring required
usernamestring
plexUsernamestring
plexTokenstring
jellyfinAuthTokenstring
userTypeinteger
permissionsnumber
avatarstring
createdAtstring required
updatedAtstring required
requestCountnumber

Example request

{
  "id": 1,
  "email": "hey@itsme.com",
  "userType": 1,
  "createdAt": "2020-09-02T05:02:23.000Z",
  "updatedAt": "2020-09-02T05:02:23.000Z",
  "requestCount": 5
}

Response

Successfully updated user details

idinteger required
emailstring required
usernamestring
plexUsernamestring
plexTokenstring
jellyfinAuthTokenstring
userTypeinteger
permissionsnumber
avatarstring
createdAtstring required
updatedAtstring required
requestCountnumber

Example response

{
  "id": 1,
  "email": "hey@itsme.com",
  "userType": 1,
  "createdAt": "2020-09-02T05:02:23.000Z",
  "updatedAt": "2020-09-02T05:02:23.000Z",
  "requestCount": 5
}

Changes

No recorded changes to this operation across all 21 revisions of this API.