mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-06 12:47:44 +00:00
37 KiB
37 KiB
PostUsersSignInDataUserPlexAccount
Returns the user account data with a valid auth token
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
ads_consent |
T::Boolean | ✔️ | Unknown | |
ads_consent_reminder_at |
Date | ✔️ | Unknown | |
ads_consent_set_at |
Date | ✔️ | Unknown | |
anonymous |
T::Boolean | ✔️ | Unknown | |
auth_token |
::String | ✔️ | The account token | CxoUzBTSV5hsxjTpFKaf |
backup_codes_created |
T::Boolean | ✔️ | If the two-factor authentication backup codes have been created | |
confirmed |
T::Boolean | ✔️ | If the account has been confirmed | |
country |
::String | ✔️ | The account country | US |
email |
::String | ✔️ | The account email address | username@email.com |
email_only_auth |
T::Boolean | ✔️ | If login with email only is enabled | |
experimental_features |
T::Boolean | ✔️ | If experimental features are enabled | |
friendly_name |
::String | ✔️ | Your account full name | friendlyUsername |
entitlements |
T::Array<::String> | ✔️ | List of devices your allowed to use with this account | |
guest |
T::Boolean | ✔️ | If the account is a Plex Home guest user | |
has_password |
T::Boolean | ✔️ | If the account has a password | |
home |
T::Boolean | ✔️ | If the account is a Plex Home user | |
home_admin |
T::Boolean | ✔️ | If the account is the Plex Home admin | |
home_size |
::Integer | ✔️ | The number of accounts in the Plex Home | 1 |
id |
::Integer | ✔️ | The Plex account ID | 13692262 |
joined_at |
::Integer | ✔️ | Unix epoch datetime in seconds | 1556281940 |
locale |
::String | ✔️ | The account locale | |
mailing_list_active |
T::Boolean | ✔️ | If you are subscribed to the Plex newsletter | |
mailing_list_status |
::PlexRubySDK::Operations::PostUsersSignInDataMailingListStatus | ✔️ | Your current mailing list status (active or unsubscribed) | active |
max_home_size |
::Integer | ✔️ | The maximum number of accounts allowed in the Plex Home | 15 |
pin |
T.nilable(::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 |
::PlexRubySDK::Operations::PostUsersSignInDataUserProfile | ✔️ | N/A | |
protected |
T::Boolean | ✔️ | If the account has a Plex Home PIN enabled | |
remember_expires_at |
::Integer | ✔️ | Unix epoch datetime in seconds | 1556281940 |
restricted |
T::Boolean | ✔️ | If the account is a Plex Home managed user | |
roles |
T::Array<::String> | ➖ | [Might be removed] List of account roles. Plexpass membership listed here | |
scrobble_types |
::String | ✔️ | Unknown | |
services |
T::Array<::PlexRubySDK::Operations::PostUsersSignInDataServices> | ✔️ | N/A | |
subscription |
::PlexRubySDK::Operations::PostUsersSignInDataSubscription | ✔️ | If the account’s Plex Pass subscription is active | |
subscription_description |
::String | ✔️ | Description of the Plex Pass subscription | |
subscriptions |
T::Array<::PlexRubySDK::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 |
two_factor_enabled |
T::Boolean | ✔️ | If two-factor authentication is enabled | |
username |
::String | ✔️ | The account username | Username |
uuid |
::String | ✔️ | The account UUID | dae343c1f45beb4f |
attribution_partner |
::String | ✔️ | N/A | |
past_subscriptions |
T::Array<::PlexRubySDK::Operations::PastSubscription> | ✔️ | N/A | |
trials |
T::Array<::PlexRubySDK::Operations::Trials> | ✔️ | N/A |