LukeParke/plex-sdk-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-sdk-docs.git synced 2025-12-09 12:37:46 +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/go/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](/go/authentication/get_transient_token) - Get a Transient Token.
* [Get Source Connection Information](/go/authentication/get_source_connection_information) - Get Source Connection Information
---
<GetTransientToken />
---
<GetSourceConnectionInformation />

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

@@ -0,0 +1,4 @@
## Get Source Connection Information
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.

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

@@ -0,0 +1,10 @@
{/* Autogenerated DO NOT EDIT */}
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `source` *{`string`}*
The source identifier with an included prefix.
<br/>
**Example:** `server://client-identifier`

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

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
import GetSourceConnectionInformationResponse from "/content/types/models/operations/get_source_connection_information_response/go.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`*operations.GetSourceConnectionInformationResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetSourceConnectionInformationResponse />
</Collapsible>
---
##### *{`error`}*

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

@@ -0,0 +1,42 @@
<CH.Code>
```go GetSourceConnectionInformation.go
package main
import(
"github.com/LukeHagar/plexgo"
"context"
"log"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
plexgo.WithXPlexClientIdentifier("Postman"),
)
var source string = "provider://provider-identifier"
ctx := context.Background()
res, err := s.Authentication.GetSourceConnectionInformation(ctx, source)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
],
"HttpMeta": {}
}
```
</CH.Code>

12
content/pages/01-reference/go/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 */}

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

@@ -0,0 +1,3 @@
## Get Transient 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.

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

@@ -0,0 +1,25 @@
{/* Autogenerated DO NOT EDIT */}
import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/go.mdx"
import Scope from "/content/types/models/operations/scope/go.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `ctx` [*{ `context.Context` }*](https://pkg.go.dev/context#Context)
The context to use for the request.
---
##### `type_` *{`operations.GetTransientTokenQueryParamType`}*
`delegation` \- This is the only supported `type` parameter.
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetTransientTokenQueryParamType />
</Collapsible>
---
##### `scope` *{`operations.Scope`}*
`all` \- This is the only supported `scope` parameter.
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<Scope />
</Collapsible>

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

@@ -0,0 +1,16 @@
{/* Autogenerated DO NOT EDIT */}
import GetTransientTokenResponse from "/content/types/models/operations/get_transient_token_response/go.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`*operations.GetTransientTokenResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetTransientTokenResponse />
</Collapsible>
---
##### *{`error`}*

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

@@ -0,0 +1,45 @@
<CH.Code>
```go GetTransientToken.go
package main
import(
"github.com/LukeHagar/plexgo"
"github.com/LukeHagar/plexgo/models/operations"
"context"
"log"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
plexgo.WithXPlexClientIdentifier("Postman"),
)
var type_ operations.GetTransientTokenQueryParamType = operations.GetTransientTokenQueryParamTypeDelegation
var scope operations.Scope = operations.ScopeAll
ctx := context.Background()
res, err := s.Authentication.GetTransientToken(ctx, type_, scope)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
],
"HttpMeta": {}
}
```
</CH.Code>

12
content/pages/01-reference/go/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 */}