mirror of
https://github.com/LukeHagar/plexcsharp.git
synced 2025-12-06 12:37:46 +00:00
52 lines
37 KiB
Markdown
52 lines
37 KiB
Markdown
# PostUsersSignInDataUserPlexAccount
|
||
|
||
Returns the user account data with a valid auth token
|
||
|
||
|
||
## Fields
|
||
|
||
| Field | Type | Required | Description | Example |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `AdsConsent` | *bool* | :heavy_check_mark: | Unknown | |
|
||
| `AdsConsentReminderAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | Unknown | |
|
||
| `AdsConsentSetAt` | [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-5.0) | :heavy_check_mark: | Unknown | |
|
||
| `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` | [PostUsersSignInDataMailingListStatus](../../Models/Requests/PostUsersSignInDataMailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
|
||
| `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` | [PostUsersSignInDataUserProfile](../../Models/Requests/PostUsersSignInDataUserProfile.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<[PostUsersSignInDataServices](../../Models/Requests/PostUsersSignInDataServices.md)> | :heavy_check_mark: | N/A | |
|
||
| `Subscription` | [PostUsersSignInDataSubscription](../../Models/Requests/PostUsersSignInDataSubscription.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` | List<[PostUsersSignInDataAuthenticationSubscription](../../Models/Requests/PostUsersSignInDataAuthenticationSubscription.md)> | :heavy_check_mark: | 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> |
|
||
| `PastSubscriptions` | List<[PastSubscription](../../Models/Requests/PastSubscription.md)> | :heavy_check_mark: | N/A | |
|
||
| `Trials` | List<[Trials](../../Models/Requests/Trials.md)> | :heavy_check_mark: | N/A | | |