mirror of
https://github.com/LukeHagar/plexphp.git
synced 2025-12-09 20:47:46 +00:00
50 lines
35 KiB
Markdown
50 lines
35 KiB
Markdown
# GetTokenDetailsUserPlexAccount
|
||
|
||
Logged in user details
|
||
|
||
|
||
## Fields
|
||
|
||
| Field | Type | Required | Description | Example |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `authToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
|
||
| `country` | *string* | :heavy_check_mark: | The account country | US |
|
||
| `email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
|
||
| `friendlyName` | *string* | :heavy_check_mark: | Your account full name | friendlyUsername |
|
||
| `entitlements` | array<*string*> | :heavy_check_mark: | List of devices your allowed to use with this account | |
|
||
| `homeSize` | *int* | :heavy_check_mark: | The number of accounts in the Plex Home | 1 |
|
||
| `id` | *int* | :heavy_check_mark: | The Plex account ID | 13692262 |
|
||
| `joinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||
| `mailingListStatus` | [Operations\MailingListStatus](../../Models/Operations/MailingListStatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
|
||
| `maxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
|
||
| `profile` | [Operations\UserProfile](../../Models/Operations/UserProfile.md) | :heavy_check_mark: | N/A | |
|
||
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
|
||
| `services` | array<[Operations\Services](../../Models/Operations/Services.md)> | :heavy_check_mark: | N/A | |
|
||
| `subscription` | [Operations\Subscription](../../Models/Operations/Subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
||
| `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 |
|
||
| `username` | *string* | :heavy_check_mark: | The account username | Username |
|
||
| `uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||
| `adsConsent` | *bool* | :heavy_check_mark: | Unknown | |
|
||
| `adsConsentReminderAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||
| `adsConsentSetAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||
| `backupCodesCreated` | *?bool* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
|
||
| `confirmed` | *?bool* | :heavy_minus_sign: | If the account has been confirmed | |
|
||
| `emailOnlyAuth` | *?bool* | :heavy_minus_sign: | If login with email only is enabled | |
|
||
| `experimentalFeatures` | *?bool* | :heavy_minus_sign: | If experimental features are enabled | |
|
||
| `guest` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home guest user | |
|
||
| `hasPassword` | *?bool* | :heavy_minus_sign: | If the account has a password | |
|
||
| `home` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home user | |
|
||
| `homeAdmin` | *?bool* | :heavy_minus_sign: | If the account is the Plex Home admin | |
|
||
| `locale` | *string* | :heavy_check_mark: | The account locale | |
|
||
| `mailingListActive` | *?bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
|
||
| ~~`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 | |
|
||
| `protected` | *?bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
|
||
| `restricted` | *?bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
|
||
| `roles` | array<*string*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
|
||
| `subscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | |
|
||
| `subscriptions` | array<[Operations\GetTokenDetailsSubscription](../../Models/Operations/GetTokenDetailsSubscription.md)> | :heavy_minus_sign: | N/A | |
|
||
| `twoFactorEnabled` | *?bool* | :heavy_minus_sign: | If two-factor authentication is enabled | |
|
||
| `attributionPartner` | *string* | :heavy_check_mark: | N/A | <nil> |
|
||
| `anonymous` | *?bool* | :heavy_minus_sign: | Unknown | | |