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

35 KiB
Raw Blame History

GetTokenDetailsUserPlexAccount

Logged in user details

Fields

Field Type Required Description Example
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
mailingListActive bool ✔️ If you are subscribed to the Plex newsletter
mailingListStatus Operations\MailingListStatus ✔️ Your current mailing list status
maxHomeSize int ✔️ The maximum number of accounts allowed in the Plex Home 15
profile Operations\UserProfile ✔️ 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
scrobbleTypes string ✔️ Unknown
services array<Operations\Services> ✔️ N/A
subscription Operations\Subscription ✔️ If the accounts Plex Pass subscription is active
subscriptions array<Operations\GetTokenDetailsSubscription> ✔️ 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
adsConsent bool ✔️ Unknown
adsConsentReminderAt \DateTime ✔️ Unknown
adsConsentSetAt \DateTime ✔️ Unknown
anonymous bool ✔️ Unknown
locale string ✔️ The account locale
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
roles array<string> [Might be removed] List of account roles. Plexpass membership listed here
subscriptionDescription string ✔️ Description of the Plex Pass subscription
attributionPartner string ✔️ N/A