Sign in
users

Import all users from Plex

Fetches and imports users from the Plex server. If a list of Plex IDs is provided in the request body, only the specified users will be imported. Otherwise, all users will be imported.

Requires the MANAGE_USERS permission.

post/user/import-from-plex

Request

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

Request body

plexIdsstring[]

Response

A list of the newly created users

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.