mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
27 lines
4.0 KiB
Markdown
27 lines
4.0 KiB
Markdown
# GetTokenByPinIdRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { GetTokenByPinIdRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
|
|
|
let value: GetTokenByPinIdRequest = {
|
|
pinID: 721343,
|
|
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
|
clientName: "Plex for Roku",
|
|
deviceNickname: "Roku 3",
|
|
clientVersion: "2.4.1",
|
|
platform: "Roku",
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
| `pinID` | *number* | :heavy_check_mark: | The PinID to retrieve an access token for | |
|
|
| `clientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
|
| `clientName` | *string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
|
| `deviceNickname` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
|
| `clientVersion` | *string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
|
| `platform` | *string* | :heavy_minus_sign: | The platform of the client application. | Roku | |