mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 04:20:46 +00:00
36 KiB
36 KiB
PostUsersSignInDataUserPlexAccount
Returns the user account data with a valid auth token
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
adsConsent |
Optional | ✔️ | Unknown | |
adsConsentReminderAt |
OffsetDateTime | ✔️ | Unknown | |
adsConsentSetAt |
OffsetDateTime | ✔️ | Unknown | |
anonymous |
JsonNullable | ➖ | Unknown | |
authToken |
String | ✔️ | The account token | CxoUzBTSV5hsxjTpFKaf |
backupCodesCreated |
Optional | ➖ | If the two-factor authentication backup codes have been created | |
confirmed |
Optional | ➖ | If the account has been confirmed | |
country |
String | ✔️ | The account country | US |
email |
String | ✔️ | The account email address | username@email.com |
emailOnlyAuth |
Optional | ➖ | If login with email only is enabled | |
experimentalFeatures |
Optional | ➖ | If experimental features are enabled | |
friendlyName |
String | ✔️ | Your account full name | friendlyUsername |
entitlements |
List<String> | ✔️ | List of devices your allowed to use with this account | |
guest |
Optional | ➖ | If the account is a Plex Home guest user | |
hasPassword |
Optional | ➖ | If the account has a password | |
home |
Optional | ➖ | If the account is a Plex Home user | |
homeAdmin |
Optional | ➖ | If the account is the Plex Home admin | |
homeSize |
int | ✔️ | The number of accounts in the Plex Home | 1 |
id |
int | ✔️ | The Plex account ID | 13692262 |
joinedAt |
int | ✔️ | Unix epoch datetime the account joined Plex | 1721154902 |
locale |
Optional | ✔️ | The account locale | |
mailingListActive |
Optional | ➖ | If you are subscribed to the Plex newsletter | |
mailingListStatus |
PostUsersSignInDataMailingListStatus | ✔️ | Your current mailing list status | |
maxHomeSize |
int | ✔️ | The maximum number of accounts allowed in the Plex Home | 15 |
pin |
Optional | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. [Might be removed] The hashed Plex Home PIN |
|
profile |
PostUsersSignInDataUserProfile | ✔️ | N/A | |
protected_ |
Optional | ➖ | If the account has a Plex Home PIN enabled | |
rememberExpiresAt |
int | ✔️ | Unix epoch datetime the authtoken expires | 1722364046 |
restricted |
Optional | ➖ | If the account is a Plex Home managed user | |
roles |
List<String> | ➖ | [Might be removed] List of account roles. Plexpass membership listed here | |
scrobbleTypes |
String | ✔️ | Unknown | |
services |
List<PostUsersSignInDataServices> | ✔️ | N/A | |
subscription |
PostUsersSignInDataSubscription | ✔️ | If the account’s Plex Pass subscription is active | |
subscriptionDescription |
Optional | ✔️ | Description of the Plex Pass subscription | |
subscriptions |
List<PostUsersSignInDataAuthenticationSubscription> | ✔️ | N/A | |
thumb |
String | ✔️ | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
title |
String | ✔️ | The title of the account (username or friendly name) | UsernameTitle |
twoFactorEnabled |
Optional | ➖ | If two-factor authentication is enabled | |
username |
String | ✔️ | The account username | Username |
uuid |
String | ✔️ | The account UUID | dae343c1f45beb4f |
pastSubscriptions |
List<PastSubscription> | ✔️ | N/A | |
trials |
List<Trials> | ✔️ | N/A |