mirror of
https://github.com/LukeHagar/plexphp.git
synced 2025-12-09 12:37:47 +00:00
51 lines
36 KiB
Markdown
51 lines
36 KiB
Markdown
# PostUsersSignInDataUserPlexAccount
|
||
|
||
Returns the user account data with a valid auth token
|
||
|
||
|
||
## Fields
|
||
|
||
| Field | Type | Required | Description | Example |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `authToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
|
||
| `backupCodesCreated` | *bool* | :heavy_check_mark: | If the two-factor authentication backup codes have been created | |
|
||
| `confirmed` | *bool* | :heavy_check_mark: | 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_check_mark: | If login with email only is enabled | |
|
||
| `experimentalFeatures` | *bool* | :heavy_check_mark: | If experimental features are enabled | |
|
||
| `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 | |
|
||
| `guest` | *bool* | :heavy_check_mark: | If the account is a Plex Home guest user | |
|
||
| `hasPassword` | *bool* | :heavy_check_mark: | If the account has a password | |
|
||
| `home` | *bool* | :heavy_check_mark: | If the account is a Plex Home user | |
|
||
| `homeAdmin` | *bool* | :heavy_check_mark: | 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` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||
| `mailingListActive` | *bool* | :heavy_check_mark: | If you are subscribed to the Plex newsletter | |
|
||
| `mailingListStatus` | [Operations\PostUsersSignInDataMailingListStatus](../../Models/Operations/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 |
|
||
| `profile` | [Operations\PostUsersSignInDataUserProfile](../../Models/Operations/PostUsersSignInDataUserProfile.md) | :heavy_check_mark: | N/A | |
|
||
| `protected` | *bool* | :heavy_check_mark: | If the account has a Plex Home PIN enabled | |
|
||
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||
| `restricted` | *bool* | :heavy_check_mark: | If the account is a Plex Home managed user | |
|
||
| `scrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
|
||
| `services` | array<[Operations\PostUsersSignInDataServices](../../Models/Operations/PostUsersSignInDataServices.md)> | :heavy_check_mark: | N/A | |
|
||
| `subscription` | [Operations\PostUsersSignInDataSubscription](../../Models/Operations/PostUsersSignInDataSubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
||
| `subscriptions` | array<[Operations\PostUsersSignInDataAuthenticationSubscription](../../Models/Operations/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_check_mark: | If two-factor authentication is enabled | |
|
||
| `username` | *string* | :heavy_check_mark: | The account username | Username |
|
||
| `uuid` | *string* | :heavy_check_mark: | The account UUID | dae343c1f45beb4f |
|
||
| `pastSubscriptions` | array<[Operations\PastSubscription](../../Models/Operations/PastSubscription.md)> | :heavy_check_mark: | N/A | |
|
||
| `trials` | array<[Operations\Trials](../../Models/Operations/Trials.md)> | :heavy_check_mark: | N/A | |
|
||
| `adsConsent` | *bool* | :heavy_check_mark: | Unknown | |
|
||
| `adsConsentReminderAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | Unknown | |
|
||
| `adsConsentSetAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | Unknown | |
|
||
| `anonymous` | *bool* | :heavy_check_mark: | Unknown | |
|
||
| `locale` | *string* | :heavy_check_mark: | The account locale | |
|
||
| ~~`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 | |
|
||
| `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 | | |