LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-06 12:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

migrated to v15

Browse Source
This commit is contained in:
Luke Hagar
2024-03-18 15:10:45 -07:00
parent f8e29c091a
commit 367dc248c3
148 changed files with 4128 additions and 1782 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/sdks/authentication/README.md Normal file
View File

@@ -0,0 +1,78 @@
# Authentication
(*Authentication*)
## Overview
API Calls regarding authentication for Plex Media Server
### Available Operations
* [GetTransientToken](#gettransienttoken) - Get a Transient Token.
* [GetSourceConnectionInformation](#getsourceconnectioninformation) - Get Source Connection Information
## GetTransientToken
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.
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
var sdk = new PlexAPISDK(AccessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Authentication.GetTransientTokenAsync(
type: GetTransientTokenQueryParamType.Delegation,
scope: Scope.All);
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `Type` | [GetTransientTokenQueryParamType](../../Models/Requests/GetTransientTokenQueryParamType.md) | :heavy_check_mark: | `delegation` - This is the only supported `type` parameter. |
| `Scope` | [Scope](../../Models/Requests/Scope.md) | :heavy_check_mark: | `all` - This is the only supported `scope` parameter. |
### Response
**[GetTransientTokenResponse](../../Models/Requests/GetTransientTokenResponse.md)**
## GetSourceConnectionInformation
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.
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
var sdk = new PlexAPISDK(AccessToken: "<YOUR_API_KEY_HERE>");
var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "server://client-identifier");
// handle response
```
### Parameters
| Parameter | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `Source` | *string* | :heavy_check_mark: | The source identifier with an included prefix. | server://client-identifier |
### Response
**[GetSourceConnectionInformationResponse](../../Models/Requests/GetSourceConnectionInformationResponse.md)**