Files
plexcsharp/docs/Models/Requests/GetTokenDetailsUserPlexAccount.md

50 lines
35 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# GetTokenDetailsUserPlexAccount
Logged in user details
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AdsConsent` | *bool* | :heavy_check_mark: | Unknown | |
| `AdsConsentReminderAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
| `AdsConsentSetAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
| `Anonymous` | *bool* | :heavy_minus_sign: | Unknown | |
| `AuthToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `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 | |
| `Country` | *string* | :heavy_check_mark: | The account country | US |
| `Email` | *string* | :heavy_check_mark: | The account email address | username@email.com |
| `EmailOnlyAuth` | *bool* | :heavy_minus_sign: | If login with email only is enabled | |
| `ExperimentalFeatures` | *bool* | :heavy_minus_sign: | If experimental features are enabled | |
| `FriendlyName` | *string* | :heavy_check_mark: | Your account full name | friendlyUsername |
| `Entitlements` | List<*string*> | :heavy_check_mark: | List of devices your allowed to use with this account | |
| `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 | |
| `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` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Locale` | *string* | :heavy_check_mark: | The account locale | |
| `MailingListActive` | *bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `MailingListStatus` | [MailingListStatus](../../Models/Requests/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 |
| ~~`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` | [UserProfile](../../Models/Requests/UserProfile.md) | :heavy_check_mark: | N/A | |
| `Protected` | *bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `RememberExpiresAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Restricted` | *bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `Roles` | List<*string*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `ScrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
| `Services` | List<[Services](../../Models/Requests/Services.md)> | :heavy_check_mark: | N/A | |
| `Subscription` | [Subscription](../../Models/Requests/Subscription.md) | :heavy_check_mark: | If the accounts Plex Pass subscription is active | |
| `SubscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `Subscriptions` | List<[GetTokenDetailsSubscription](../../Models/Requests/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` | *bool* | :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> |