LukeParke/plex-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-docs.git synced 2025-12-06 04:20:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9e0c39c66bcd0ec90e22290b5731a774927c2d1c
plex-docs/docs/plex-media-server/get-my-plex-account.api.mdx
Luke Hagar 9e0c39c66b dev changes
2023-04-20 07:50:46 -05:00

37 lines
11 KiB
Plaintext
Raw Blame History

---
id: get-my-plex-account
sidebar_label: Get MyPlex Account
hide_title: true
hide_table_of_contents: true
api: {"tags":["MyPlex"],"description":"Returns MyPlex Account Information","operationId":"getMyPlexAccount","responses":{"200":{"description":"MyPlex Account","content":{"application/json":{"schema":{"type":"object","properties":{"MyPlex":{"type":"object","properties":{"authToken":{"type":"string","example":"Z5v-PrNASDFpsaCi3CPK7"},"username":{"type":"string","example":"example.email@mail.com"},"mappingState":{"type":"string","example":"mapped"},"mappingError":{"type":"string","example":null},"signInState":{"type":"string","example":"ok"},"publicAddress":{"type":"string","example":"140.20.68.140"},"publicPort":{"type":"number","example":32400},"privateAddress":{"type":"string","example":"10.10.10.47"},"privatePort":{"type":"number","example":32400},"subscriptionFeatures":{"type":"string","example":"federated-auth,hardware_transcoding,home,hwtranscode,item_clusters,kevin-bacon,livetv,loudness,lyrics,music-analysis,music_videos,pass,photo_autotags,photos-v5,photosV6-edit,photosV6-tv-albums,premium_music_metadata,radio,server-manager,session_bandwidth_restrictions,session_kick,shared-radio,sync,trailers,tuner-sharing,type-first,unsupportedtuners,webhooks"},"subscriptionActive":{"type":"boolean"},"subscriptionState":{"type":"string","example":"Active"}}}}}}}},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number","example":1001},"message":{"type":"string","example":"User could not be authenticated"},"status":{"type":"number","example":401}}}}}}}}}},"method":"get","path":"/myplex/account","servers":[{"url":"http://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}},{"url":"https://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"Token":[],"ClientIdentifier":[],"Device":[],"DeviceName":[],"Platform":[],"PlatformVersion":[],"Product":[],"Version":[]}],"securitySchemes":{"Token":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Token"},"ClientIdentifier":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Client-Identifier"},"DeviceName":{"description":"Primary name for the device eg. `Plex Web (Chrome)`","type":"apiKey","in":"header","name":"X-Plex-Device-Name"},"Device":{"description":"The type of device your application is running on\nDevice name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV`\n","type":"apiKey","in":"header","name":"X-Plex-Device"},"PlatformVersion":{"description":"Operating system version\neg `4.3.1`, `10.6.7`, `3.2`\n","type":"apiKey","in":"header","name":"X-Plex-Platform-Version"},"Platform":{"description":"Platform name \neg: `Web`, `iOS`, `MacOSX`, `Android`, `LG`\n","type":"apiKey","in":"header","name":"X-Plex-Platform"},"Product":{"description":"Plex application name \neg: `Laika`, `Plex Media Server`, `Media Link`\n","type":"apiKey","in":"header","name":"X-Plex-Product"},"Version":{"description":"Plex application version number","type":"apiKey","in":"header","name":"X-Plex-Version"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.3","contact":{"name":"Luke Hagar","url":"https://www.LukeHagar.com","email":"Lukeslakemail@gmail.com"},"license":{"name":"MIT","identifier":"MIT","url":"https://opensource.org/licenses/MIT"}},"postman":{"name":"Get MyPlex Account","description":{"content":"Returns MyPlex Account Information","type":"text/plain"},"url":{"path":["myplex","account"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: docs/plex-media-server/plex-api
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Get MyPlex Account</h1>
<MethodEndpoint method={"get"} path={"/myplex/account"}></MethodEndpoint>
Returns MyPlex Account Information
<div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
MyPlex Account
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>MyPlex</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"authToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Z5v-PrNASDFpsaCi3CPK7"}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"example.email@mail.com"}}></SchemaItem><SchemaItem collapsible={false} name={"mappingState"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"mapped"}}></SchemaItem><SchemaItem collapsible={false} name={"mappingError"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":null}}></SchemaItem><SchemaItem collapsible={false} name={"signInState"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"ok"}}></SchemaItem><SchemaItem collapsible={false} name={"publicAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"140.20.68.140"}}></SchemaItem><SchemaItem collapsible={false} name={"publicPort"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":32400}}></SchemaItem><SchemaItem collapsible={false} name={"privateAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"10.10.10.47"}}></SchemaItem><SchemaItem collapsible={false} name={"privatePort"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":32400}}></SchemaItem><SchemaItem collapsible={false} name={"subscriptionFeatures"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"federated-auth,hardware_transcoding,home,hwtranscode,item_clusters,kevin-bacon,livetv,loudness,lyrics,music-analysis,music_videos,pass,photo_autotags,photos-v5,photosV6-edit,photosV6-tv-albums,premium_music_metadata,radio,server-manager,session_bandwidth_restrictions,session_kick,shared-radio,sync,trailers,tuner-sharing,type-first,unsupportedtuners,webhooks"}}></SchemaItem><SchemaItem collapsible={false} name={"subscriptionActive"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"subscriptionState"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Active"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"MyPlex\": {\n \"authToken\": \"Z5v-PrNASDFpsaCi3CPK7\",\n \"username\": \"example.email@mail.com\",\n \"mappingState\": \"mapped\",\n \"mappingError\": null,\n \"signInState\": \"ok\",\n \"publicAddress\": \"140.20.68.140\",\n \"publicPort\": 32400,\n \"privateAddress\": \"10.10.10.47\",\n \"privatePort\": 32400,\n \"subscriptionFeatures\": \"federated-auth,hardware_transcoding,home,hwtranscode,item_clusters,kevin-bacon,livetv,loudness,lyrics,music-analysis,music_videos,pass,photo_autotags,photos-v5,photosV6-edit,photosV6-tv-albums,premium_music_metadata,radio,server-manager,session_bandwidth_restrictions,session_kick,shared-radio,sync,trailers,tuner-sharing,type-first,unsupportedtuners,webhooks\",\n \"subscriptionActive\": true,\n \"subscriptionState\": \"Active\"\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>errors</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"code"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":1001}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"User could not be authenticated"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","example":401}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"errors\": [\n {\n \"code\": 1001,\n \"message\": \"User could not be authenticated\",\n \"status\": 401\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink