Files
plexphp/docs/Models/Operations/PostUsersSignInDataUserPlexAccount.md

37 KiB
Raw Blame History

PostUsersSignInDataUserPlexAccount

Returns the user account data with a valid auth token

Fields

Field Type Required Description Example
adsConsent bool ✔️ Unknown
adsConsentReminderAt int ✔️ N/A 1556281940
adsConsentSetAt int ✔️ N/A 1556281940
anonymous ?bool Unknown
authToken string ✔️ The account token CxoUzBTSV5hsxjTpFKaf
backupCodesCreated ?bool If the two-factor authentication backup codes have been created
confirmed ?bool If the account has been confirmed
country string ✔️ The account country US
email string ✔️ The account email address username@email.com
emailOnlyAuth ?bool If login with email only is enabled
experimentalFeatures ?bool If experimental features are enabled
friendlyName string ✔️ Your account full name friendlyUsername
entitlements array<string> ✔️ List of devices your allowed to use with this account
guest ?bool If the account is a Plex Home guest user
hasPassword ?bool If the account has a password
home ?bool If the account is a Plex Home user
homeAdmin ?bool 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 in seconds 1556281940
locale string ✔️ The account locale
mailingListActive ?bool If you are subscribed to the Plex newsletter
mailingListStatus Operations\PostUsersSignInDataMailingListStatus ✔️ Your current mailing list status (active or unsubscribed) active
maxHomeSize int ✔️ The maximum number of accounts allowed in the Plex Home 15
pin ?string : 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 Operations\PostUsersSignInDataUserProfile ✔️ N/A
protected ?bool If the account has a Plex Home PIN enabled
rememberExpiresAt int ✔️ Unix epoch datetime in seconds 1556281940
restricted ?bool If the account is a Plex Home managed user
roles array<string> [Might be removed] List of account roles. Plexpass membership listed here
scrobbleTypes string ✔️ Unknown
services array<Operations\PostUsersSignInDataServices> ✔️ N/A
subscription Operations\PostUsersSignInDataSubscription ✔️ If the accounts Plex Pass subscription is active
subscriptionDescription string ✔️ Description of the Plex Pass subscription
subscriptions array<Operations\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 ?bool If two-factor authentication is enabled
username string ✔️ The account username Username
uuid string ✔️ The account UUID dae343c1f45beb4f
attributionPartner string ✔️ N/A
pastSubscriptions array<Operations\PastSubscription> ✔️ N/A
trials array<Operations\Trials> ✔️ N/A