Class MyPlexAccount

MyPlex account and profile information. This object represents the data found Account on the myplex.tv servers at the url https://plex.tv/users/account. You may create this object directly by passing in your username & password (or token). There is also a convenience method provided at :class:~plexapi.server.PlexServer.myPlexAccount() which will create and return this object.

Constructors

constructor

Properties

EXISTINGUSER FRIENDINVITE FRIENDSERVERS FRIENDUPDATE HOMEUSERCREATE PLEXSERVERS REMOVEHOMEUSER REMOVEINVITE REQUESTED REQUESTS SIGNIN WEBHOOKS authenticationToken? baseUrl certificateVersion? email? entitlements? guest? home? homeSize? id? locale? mailingListActive? mailingListStatus? maxHomeSize? password? queueEmail? restricted? scrobbleTypes? server? subscriptionActive? subscriptionFeatures? subscriptionPlan? subscriptionStatus? thumb? timeout title? token? username? uuid? key

Methods

_headers claimServer claimToken connect device devices query resource resources getWebLogin webLoginCheck

Constructors

constructor

  • new MyPlexAccount(baseUrl?, username?, password?, token?, timeout?, server?): MyPlexAccount

  • Parameters

    • baseUrl: string = null
    • Optionalusername: string

      Your MyPlex username

    • Optionalpassword: string

      Your MyPlex password

    • Optionaltoken: string

      Token used to access this client.

    • timeout: number = TIMEOUT

      timeout in seconds on initial connect to myplex

    • Optionalserver: PlexServer

      not often available

    Returns MyPlexAccount

Properties

EXISTINGUSER

EXISTINGUSER: string = 'https://plex.tv/api/home/users?invitedEmail={username}'

FRIENDINVITE

FRIENDINVITE: string = 'https://plex.tv/api/servers/{machineId}/shared_servers'

FRIENDSERVERS

FRIENDSERVERS: string = 'https://plex.tv/api/servers/{machineId}/shared_servers/{serverId}'

FRIENDUPDATE

FRIENDUPDATE: string = 'https://plex.tv/api/friends/{userId}'

HOMEUSERCREATE

HOMEUSERCREATE: string = 'https://plex.tv/api/home/users?title={title}'

PLEXSERVERS

PLEXSERVERS: string = 'https://plex.tv/api/servers/{machineId}'

REMOVEHOMEUSER

REMOVEHOMEUSER: string = 'https://plex.tv/api/home/users/{userId}'

REMOVEINVITE

REMOVEINVITE: string = 'https://plex.tv/api/invites/requested/{userId}?friend=0&server=1&home=0'

REQUESTED

REQUESTED: string = 'https://plex.tv/api/invites/requested'

REQUESTS

REQUESTS: string = 'https://plex.tv/api/invites/requests'

SIGNIN

SIGNIN: string = 'https://plex.tv/users/sign_in.json'

WEBHOOKS

WEBHOOKS: string = 'https://plex.tv/api/v2/user/webhooks'

OptionalauthenticationToken

authenticationToken?: string

auth token for user by plex

baseUrl

baseUrl: string = null

OptionalcertificateVersion

certificateVersion?: number

Unknown

Optionalemail

email?: string

Your current Plex email address

Optionalentitlements

entitlements?: string[]

List of devices your allowed to use with this account

Optionalguest

guest?: boolean

Unknown

Optionalhome

home?: boolean

Unknown

OptionalhomeSize

homeSize?: number

Unknown

Optionalid

id?: number

Your Plex account ID

Optionallocale

locale?: string

Your Plex locale

OptionalmailingListActive

mailingListActive?: boolean

OptionalmailingListStatus

mailingListStatus?: "active" | "inactive"

Your current mailing list status.

OptionalmaxHomeSize

maxHomeSize?: number

Unknown

Optionalpassword

password?: string

Your MyPlex password

OptionalqueueEmail

queueEmail?: string

Email address to add items to your Watch Later queue.

Optionalrestricted

restricted?: boolean

Unknown

OptionalscrobbleTypes

scrobbleTypes?: string

Description

Optionalserver

server?: PlexServer

not often available

OptionalsubscriptionActive

subscriptionActive?: boolean

True if your subsctiption is active

OptionalsubscriptionFeatures

subscriptionFeatures?: string[]

List of features allowed on your subscription

OptionalsubscriptionPlan

subscriptionPlan?: string

Name of subscription plan

OptionalsubscriptionStatus

subscriptionStatus?: "active" | "inactive"

String representation of subscriptionActive

Optionalthumb

thumb?: string

URL of your account thumbnail

timeout

timeout: number = TIMEOUT

timeout in seconds on initial connect to myplex

Optionaltitle

title?: string

Unknown. - Looks like an alias for username

Optionaltoken

token?: string

Token used to access this client.

Optionalusername

username?: string

Your MyPlex username

Optionaluuid

uuid?: string

Unknown

Statickey

key: string = 'https://plex.tv/api/v2/user'

Methods

_headers

  • _headers(): Record<string, string>

  • Returns Record<string, string>

claimServer

  • claimServer(token): Promise<any>

  • Parameters

    • token: string

      pass token from claimToken

    Returns Promise<any>

claimToken

connect

  • connect(): Promise<MyPlexAccount>

  • Returns a new :class:~server.PlexServer or :class:~client.PlexClient object. Often times there is more than one address specified for a server or client. This function will prioritize local connections before remote and HTTPS before HTTP. After trying to connect to all available addresses for this resource and assuming at least one connection was successful, the PlexServer object is built and returned.

    Returns Promise<MyPlexAccount>

device

  • device(name?, clientId?): Promise<MyPlexDevice>

  • Parameters

    • name: string = ''

      Name to match against.

    • OptionalclientId: string

      clientIdentifier to match against.

    Returns Promise<MyPlexDevice>

devices

  • devices(): Promise<MyPlexDevice[]>

  • Returns a list of all :class:~plexapi.myplex.MyPlexDevice objects connected to the server.

    Returns Promise<MyPlexDevice[]>

query

  • query<T>(url, method?, headers?, username?, password?): Promise<T>

  • Main method used to handle HTTPS requests to the Plex client. This method helps by encoding the response to utf-8 and parsing the returned XML into and ElementTree object. Returns None if no data exists in the response. TODO: use headers

    Type Parameters

    • T = any

    Parameters

    • url: string
    • method:
          | "get"
          | "post"
          | "put"
          | "patch"
          | "head"
          | "delete" = 'get'
    • Optionalheaders: any
    • Optionalusername: string
    • Optionalpassword: string

    Returns Promise<T>

resource

  • resource(name): Promise<MyPlexResource>

  • Returns the :class:~plexapi.myplex.MyPlexResource that matches the name specified.

    Parameters

    • name: string

    Returns Promise<MyPlexResource>

resources

StaticgetWebLogin

  • getWebLogin(forwardUrl?): Promise<WebLogin>

  • This follows the outline described in https://forums.plex.tv/t/authenticating-with-plex/609370 to fetch a token and potentially compromise username and password. To use first call getWebLogin() and present the returned uri to a user to go to, then await webLoginCheck(). If you pass in a forwardUrl, then send the user to the returned uri, and when a request comes in on the passed in url, then await webLoginCheck().

    Parameters

    • forwardUrl: string = null

    Returns Promise<WebLogin>

StaticwebLoginCheck

  • webLoginCheck(webLogin, timeoutSeconds?): Promise<MyPlexAccount>

  • Pass in the webLogin object obtained from getWebLogin() and this will poll Plex to see if the user agreed. It returns a connected MyPlexAccount or throws an error.

    Parameters

    • webLogin: WebLogin
    • timeoutSeconds: number = 60

    Returns Promise<MyPlexAccount>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods