LukeParke/plex-sdk-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-sdk-docs.git synced 2025-12-09 04:20:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.303.0

Browse Source
This commit is contained in:
speakeasybot
2024-06-11 00:33:50 +00:00
parent 6748e94a9a
commit e74bc056f6
491 changed files with 4181 additions and 2758 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
content/pages/01-reference/curl/resources/authentication/authentication.mdx Normal file
View File

@@ -0,0 +1,17 @@
import GetTransientToken from "./get_transient_token/get_transient_token.mdx";
import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx";
## Authentication
API Calls regarding authentication for Plex Media Server
### Available Operations
* [Get Transient Token](/curl/authentication/get_transient_token) - Get a Transient Token.
* [Get Source Connection Information](/curl/authentication/get_source_connection_information) - Get Source Connection Information
---
<GetTransientToken />
---
<GetSourceConnectionInformation />

9
content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_authentication.mdx Normal file
View File

@@ -0,0 +1,9 @@
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### API key _— in HTTP header_
Set your API key in a `X-Plex-Token` HTTP header.
Example: `<no value>`

9
content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_header.mdx Normal file
View File

@@ -0,0 +1,9 @@
import OperationInfo from '/src/components/OperationInfo';
## Get Source Connection Information
<OperationInfo method='get' path='/security/resources' />
If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.
Note: requires Plex Media Server >= 1.15.4.

6
content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_parameters.mdx Normal file
View File

@@ -0,0 +1,6 @@
{/* Autogenerated DO NOT EDIT */}
##### `source` _string_
The source identifier with an included prefix.
<br/>
**Example:** `server://client-identifier`

26
content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_response.mdx Normal file
View File

@@ -0,0 +1,26 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
import { TabbedSection, Tab } from '@/src/components/TabbedSection';
import StatusCode from '@/src/components/StatusCode';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"401"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

21
content/pages/01-reference/curl/resources/authentication/get_source_connection_information/_usage.mdx Normal file
View File

@@ -0,0 +1,21 @@
<CH.Code>
```bash Example Request
curl http://10.10.10.47:32400/security/resources?source=provider%3A%2F%2Fprovider-identifier \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
]
}
```
</CH.Code>

12
content/pages/01-reference/curl/resources/authentication/get_source_connection_information/get_source_connection_information.mdx Normal file
View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Authentication*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

9
content/pages/01-reference/curl/resources/authentication/get_transient_token/_authentication.mdx Normal file
View File

@@ -0,0 +1,9 @@
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### API key _— in HTTP header_
Set your API key in a `X-Plex-Token` HTTP header.
Example: `<no value>`

8
content/pages/01-reference/curl/resources/authentication/get_transient_token/_header.mdx Normal file
View File

@@ -0,0 +1,8 @@
import OperationInfo from '/src/components/OperationInfo';
## Get Transient Token
<OperationInfo method='get' path='/security/token' />
This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.

21
content/pages/01-reference/curl/resources/authentication/get_transient_token/_parameters.mdx Normal file
View File

@@ -0,0 +1,21 @@
{/* Autogenerated DO NOT EDIT */}
import GetTransientTokenQueryParamType from "/content/types/operations/get_transient_token_query_param_type/curl.mdx"
import Scope from "/content/types/operations/scope/curl.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `type` _enumeration_
`delegation` \- This is the only supported `type` parameter.
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetTransientTokenQueryParamType />
</Collapsible>
---
##### `scope` _enumeration_
`all` \- This is the only supported `scope` parameter.
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<Scope />
</Collapsible>

26
content/pages/01-reference/curl/resources/authentication/get_transient_token/_response.mdx Normal file
View File

@@ -0,0 +1,26 @@
{/* Autogenerated DO NOT EDIT */}
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
import { TabbedSection, Tab } from '@/src/components/TabbedSection';
import StatusCode from '@/src/components/StatusCode';
<TabbedSection tabLabel='Status Code'>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"200"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"400"} />}>
_No response body._
</Tab>
{/* prettier-ignore */}
<Tab title={<StatusCode code={"401"} />}>
*JSON object*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
##### `errors` _array (optional)_
</Collapsible>
</Tab>
</TabbedSection>

21
content/pages/01-reference/curl/resources/authentication/get_transient_token/_usage.mdx Normal file
View File

@@ -0,0 +1,21 @@
<CH.Code>
```bash Example Request
curl http://10.10.10.47:32400/security/token \
--header 'Accept: application/json' \
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
]
}
```
</CH.Code>

12
content/pages/01-reference/curl/resources/authentication/get_transient_token/get_transient_token.mdx Normal file
View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Authentication*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}