mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
49 lines
35 KiB
Markdown
49 lines
35 KiB
Markdown
# GetUserDetailsUserPlexAccount
|
||
|
||
Logged in user details
|
||
|
||
|
||
## Fields
|
||
|
||
| Field | Type | Required | Description | Example |
|
||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `adsConsent` | *Optional<Boolean>* | :heavy_check_mark: | Unknown | |
|
||
| `adsConsentReminderAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | Unknown | |
|
||
| `adsConsentSetAt` | [OffsetDateTime](https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html) | :heavy_check_mark: | Unknown | |
|
||
| `anonymous` | *JsonNullable<Boolean>* | :heavy_minus_sign: | Unknown | |
|
||
| `authToken` | *String* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
|
||
| `backupCodesCreated` | *Optional<Boolean>* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
|
||
| `confirmed` | *Optional<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` | *Optional<Boolean>* | :heavy_minus_sign: | If login with email only is enabled | |
|
||
| `experimentalFeatures` | *Optional<Boolean>* | :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` | *Optional<Boolean>* | :heavy_minus_sign: | If the account is a Plex Home guest user | |
|
||
| `hasPassword` | *Optional<Boolean>* | :heavy_minus_sign: | If the account has a password | |
|
||
| `home` | *Optional<Boolean>* | :heavy_minus_sign: | If the account is a Plex Home user | |
|
||
| `homeAdmin` | *Optional<Boolean>* | :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` | *int* | :heavy_check_mark: | Unix epoch datetime the account joined Plex | 1721154902 |
|
||
| `locale` | *Optional<String>* | :heavy_check_mark: | The account locale | |
|
||
| `mailingListActive` | *Optional<Boolean>* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
|
||
| `mailingListStatus` | [MailingListStatus](../../models/operations/MailingListStatus.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`~~ | *Optional<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/operations/UserProfile.md) | :heavy_check_mark: | N/A | |
|
||
| `protected_` | *Optional<Boolean>* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
|
||
| `rememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime the authtoken expires | 1722364046 |
|
||
| `restricted` | *Optional<Boolean>* | :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/operations/Services.md)> | :heavy_check_mark: | N/A | |
|
||
| `subscription` | [Subscription](../../models/operations/Subscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
|
||
| `subscriptionDescription` | *Optional<String>* | :heavy_check_mark: | Description of the Plex Pass subscription | |
|
||
| `subscriptions` | List<[GetUserDetailsSubscription](../../models/operations/GetUserDetailsSubscription.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` | *Optional<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 | |