plexjs/docs/sdk/models/operations/postuserssignindatauserplexaccount.md

PostUsersSignInDataUserPlexAccount

Returns the user account data with a valid auth token

Example Usage

import {
  PostUsersSignInDataAuthenticationFeatures,
  PostUsersSignInDataAuthenticationResponseStatus,
  PostUsersSignInDataAuthenticationStatus,
  PostUsersSignInDataAutoSelectSubtitle,
  PostUsersSignInDataDefaultSubtitleAccessibility,
  PostUsersSignInDataDefaultSubtitleForced,
  PostUsersSignInDataFeatures,
  PostUsersSignInDataMailingListStatus,
  PostUsersSignInDataMediaReviewsVisibility,
  PostUsersSignInDataState,
  PostUsersSignInDataStatus,
  PostUsersSignInDataUserPlexAccount,
  PostUsersSignInDataWatchedIndicator,
} from "@lukehagar/plexjs/sdk/models/operations";

let value: PostUsersSignInDataUserPlexAccount = {
  adsConsent: true,
  adsConsentReminderAt: new Date("2019-08-24T14:15:22Z"),
  adsConsentSetAt: new Date("2019-08-24T14:15:22Z"),
  anonymous: false,
  authToken: "CxoUzBTSV5hsxjTpFKaf",
  backupCodesCreated: false,
  confirmed: false,
  country: "US",
  email: "username@email.com",
  emailOnlyAuth: false,
  experimentalFeatures: false,
  friendlyName: "friendlyUsername",
  entitlements: [
    "[]",
  ],
  guest: false,
  hasPassword: true,
  home: false,
  homeAdmin: false,
  homeSize: 1,
  id: 13692262,
  joinedAt: 1721154902,
  locale: null,
  mailingListActive: false,
  mailingListStatus: PostUsersSignInDataMailingListStatus.Active,
  maxHomeSize: 15,
  pin: "string",
  profile: {
    autoSelectAudio: true,
    defaultAudioLanguage: "ja",
    defaultSubtitleLanguage: "en",
    autoSelectSubtitle: PostUsersSignInDataAutoSelectSubtitle.One,
    defaultSubtitleAccessibility:
      PostUsersSignInDataDefaultSubtitleAccessibility.One,
    defaultSubtitleForced: PostUsersSignInDataDefaultSubtitleForced.Zero,
    watchedIndicator: PostUsersSignInDataWatchedIndicator.One,
    mediaReviewsVisibility: PostUsersSignInDataMediaReviewsVisibility.One,
  },
  protected: false,
  rememberExpiresAt: 1722364046,
  restricted: false,
  roles: [
    "string",
  ],
  scrobbleTypes: "",
  services: [
    {
      identifier: "metadata-dev",
      endpoint: "https://epg.provider.plex.tv",
      token: "DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv",
      secret: "string",
      status: PostUsersSignInDataStatus.Online,
    },
  ],
  subscription: {
    features: [
      PostUsersSignInDataFeatures.AndroidDolbyVision,
    ],
    active: true,
    subscribedAt: "2021-04-12T18:21:12Z",
    status: PostUsersSignInDataAuthenticationStatus.Inactive,
    paymentService: "string",
    plan: "string",
  },
  subscriptionDescription: "string",
  subscriptions: [
    {
      features: [
        PostUsersSignInDataAuthenticationFeatures.AndroidDolbyVision,
      ],
      active: true,
      subscribedAt: "2021-04-12T18:21:12Z",
      status: PostUsersSignInDataAuthenticationResponseStatus.Inactive,
      paymentService: "string",
      plan: "string",
    },
  ],
  thumb: "https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101",
  title: "UsernameTitle",
  twoFactorEnabled: false,
  username: "Username",
  uuid: "dae343c1f45beb4f",
  pastSubscriptions: [
    {
      id: "string",
      mode: "string",
      renewsAt: string,
      endsAt: 1556281940,
      canceled: true,
      gracePeriod: true,
      onHold: true,
      canReactivate: true,
      canUpgrade: true,
      canDowngrade: true,
      canConvert: true,
      type: "plexpass",
      transfer: "string",
      state: PostUsersSignInDataState.Ended,
      billing: {
        internalPaymentMethod: {},
        paymentMethodId: 565189,
      },
    },
  ],
  trials: [
    {},
  ],
};

Fields

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