plexjs/docs/sdk/models/operations/getusersrequest.md

GetUsersRequest

Example Usage

import { GetUsersRequest } from "@lukehagar/plexjs/sdk/models/operations";

let value: GetUsersRequest = {
  clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
  clientName: "Plex for Roku",
  deviceNickname: "Roku 3",
  deviceName: "Chrome",
  deviceScreenResolution: "1487x1165,2560x1440",
  clientVersion: "2.4.1",
  platform: "Roku",
  clientFeatures: "external-media,indirect-media,hub-style-list",
  model: "4200X",
  xPlexSessionId: "97e136ef-4ddd-4ff3-89a7-a5820c96c2ca",
  xPlexLanguage: "en",
  platformVersion: "4.3 build 1057",
  xPlexToken: "CV5xoxjTpFKUzBTShsaf",
};

Fields

Field	Type	Required	Description	Example
clientID	string	✔️	An opaque identifier unique to the client (UUID, serial number, or other unique device ID)	3381b62b-9ab7-4e37-827b-203e9809eb58
clientName	string	➖	The name of the client application. (Plex Web, Plex Media Server, etc.)	Plex for Roku
deviceNickname	string	➖	A relatively friendly name for the client device	Roku 3
deviceName	string	➖	The name of the device the client application is running on. This is used to track the client application and its usage. (Chrome, Safari, etc.)	Chrome
deviceScreenResolution	string	➖	The resolution of the device the client application is running on. This is used to track the client application and its usage. (1487x1165,2560x1440)	1487x1165,2560x1440
clientVersion	string	➖	The version of the client application.	2.4.1
platform	string	➖	The platform of the client application.	Roku
clientFeatures	string	➖	The features of the client application. This is used to track the client application and its usage. (external-media,indirect-media,hub-style-list)	external-media,indirect-media,hub-style-list
model	string	➖	A potentially less friendly identifier for the device model	4200X
xPlexSessionId	string	➖	The session ID of the client application. This is used to track the client application and its usage. (97e136ef-4ddd-4ff3-89a7-a5820c96c2ca)	97e136ef-4ddd-4ff3-89a7-a5820c96c2ca
xPlexLanguage	string	➖	The language of the client application.	en
platformVersion	string	➖	The version of the platform	4.3 build 1057
xPlexToken	string	✔️	An authentication token, obtained from plex.tv	CV5xoxjTpFKUzBTShsaf