Authentication

(Authentication)

Overview

API Calls regarding authentication for Plex Media Server

Available Operations

GetTransientToken - Get a Transient Token.
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

using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman");

var res = await sdk.Authentication.GetTransientTokenAsync(
    type: PlexAPI.Models.Requests.GetTransientTokenQueryParamType.Delegation,
    scope: PlexAPI.Models.Requests.Scope.All);

// handle response

Parameters

Parameter	Type	Required	Description
`Type`	GetTransientTokenQueryParamType	✔️	`delegation` - This is the only supported `type` parameter.
`Scope`	Scope	✔️	`all` - This is the only supported `scope` parameter.

Response

GetTransientTokenResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.GetTransientTokenResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/

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

using PlexAPI;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;

var sdk = new PlexAPISDK(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "Postman");

var res = await sdk.Authentication.GetSourceConnectionInformationAsync(source: "server://client-identifier");

// handle response

Parameters

Parameter	Type	Required	Description	Example
`Source`	string	✔️	The source identifier with an included prefix.	server://client-identifier

Response

GetSourceConnectionInformationResponse

Errors

Error Object	Status Code	Content Type
PlexAPI.Models.Errors.GetSourceConnectionInformationResponseBody	401	application/json
PlexAPI.Models.Errors.SDKException	4xx-5xx	/