mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
113 lines
37 KiB
Markdown
113 lines
37 KiB
Markdown
# GetTokenDetailsUserPlexAccount
|
||
|
||
Logged in user details
|
||
|
||
## Example Usage
|
||
|
||
```typescript
|
||
import {
|
||
GetTokenDetailsAuthenticationResponseStatus,
|
||
GetTokenDetailsAuthenticationStatus,
|
||
GetTokenDetailsStatus,
|
||
GetTokenDetailsUserPlexAccount,
|
||
MailingListStatus,
|
||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||
|
||
let value: GetTokenDetailsUserPlexAccount = {
|
||
adsConsent: false,
|
||
adsConsentReminderAt: 1556281940,
|
||
adsConsentSetAt: 1556281940,
|
||
authToken: "CxoUzBTSV5hsxjTpFKaf",
|
||
country: "US",
|
||
email: "username@email.com",
|
||
friendlyName: "friendlyUsername",
|
||
entitlements: [
|
||
"[]",
|
||
],
|
||
homeSize: 1,
|
||
id: 13692262,
|
||
joinedAt: 1556281940,
|
||
locale: "el",
|
||
mailingListStatus: MailingListStatus.Active,
|
||
maxHomeSize: 15,
|
||
profile: {
|
||
defaultAudioLanguage: "ja",
|
||
defaultSubtitleLanguage: "en",
|
||
},
|
||
rememberExpiresAt: 1556281940,
|
||
scrobbleTypes: "<value>",
|
||
services: [
|
||
{
|
||
identifier: "metadata-dev",
|
||
endpoint: "https://epg.provider.plex.tv",
|
||
token: "DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv",
|
||
secret: "<value>",
|
||
status: GetTokenDetailsStatus.Online,
|
||
},
|
||
],
|
||
subscription: {
|
||
active: true,
|
||
subscribedAt: "2021-04-12T18:21:12Z",
|
||
status: GetTokenDetailsAuthenticationStatus.Inactive,
|
||
},
|
||
subscriptionDescription: "<value>",
|
||
subscriptions: [
|
||
{
|
||
active: true,
|
||
subscribedAt: "2021-04-12T18:21:12Z",
|
||
status: GetTokenDetailsAuthenticationResponseStatus.Inactive,
|
||
},
|
||
],
|
||
thumb: "https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101",
|
||
title: "UsernameTitle",
|
||
username: "Username",
|
||
uuid: "dae343c1f45beb4f",
|
||
attributionPartner: null,
|
||
};
|
||
```
|
||
|
||
## Fields
|
||
|
||
| Field | Type | Required | Description | Example |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `adsConsent` | *boolean* | :heavy_check_mark: | Unknown | |
|
||
| `adsConsentReminderAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||
| `adsConsentSetAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||
| `anonymous` | *boolean* | :heavy_minus_sign: | Unknown | |
|
||
| `authToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
|
||
| `backupCodesCreated` | *boolean* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
|
||
| `confirmed` | *boolean* | :heavy_minus_sign: | If the account has been confirmed | |
|
||
| `country` | *string* | :heavy_check_mark: | The account country | US |
|
||
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
|
||
| `emailOnlyAuth` | *boolean* | :heavy_minus_sign: | If login with email only is enabled | |
|
||
| `experimentalFeatures` | *boolean* | :heavy_minus_sign: | If experimental features are enabled | |
|
||
| `friendlyName` | *string* | :heavy_check_mark: | Your account full name | friendlyUsername |
|
||
| `entitlements` | *string*[] | :heavy_check_mark: | List of devices your allowed to use with this account | |
|
||
| `guest` | *boolean* | :heavy_minus_sign: | If the account is a Plex Home guest user | |
|
||
| `hasPassword` | *boolean* | :heavy_minus_sign: | If the account has a password | |
|
||
| `home` | *boolean* | :heavy_minus_sign: | If the account is a Plex Home user | |
|
||
| `homeAdmin` | *boolean* | :heavy_minus_sign: | If the account is the Plex Home admin | |
|
||
| `homeSize` | *number* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
|
||
| `id` | *number* | :heavy_check_mark: | The Plex account ID | 13692262 |
|
||
| `joinedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||
| `locale` | *string* | :heavy_check_mark: | The account locale | |
|
||
| `mailingListActive` | *boolean* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
|
||
| `mailingListStatus` | [operations.MailingListStatus](../../../sdk/models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
|
||
| `maxHomeSize` | *number* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
|
||
| ~~`pin`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
|
||
| `profile` | [operations.UserProfile](../../../sdk/models/operations/userprofile.md) | :heavy_check_mark: | N/A | |
|
||
| `protected` | *boolean* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
|
||
| `rememberExpiresAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||
| `restricted` | *boolean* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
|
||
| `roles` | *string*[] | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
|
||
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
|
||
| `services` | [operations.Services](../../../sdk/models/operations/services.md)[] | :heavy_check_mark: | N/A | |
|
||
| `subscription` | [operations.Subscription](../../../sdk/models/operations/subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
||
| `subscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | |
|
||
| `subscriptions` | [operations.GetTokenDetailsSubscription](../../../sdk/models/operations/gettokendetailssubscription.md)[] | :heavy_minus_sign: | N/A | |
|
||
| `thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
|
||
| `title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
|
||
| `twoFactorEnabled` | *boolean* | :heavy_minus_sign: | If two-factor authentication is enabled | |
|
||
| `username` | *string* | :heavy_check_mark: | The account username | Username |
|
||
| `uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||
| `attributionPartner` | *string* | :heavy_check_mark: | N/A | <nil> | |