sources_plex_redeem_token_create

POST 
/api/v3//sources/plex/redeem_token/

Redeem a plex token, check it's access to resources against what's allowed for the source, and redirect to an authentication/enrollment flow.

Request

Query Parameters

slug string

application/json

Body

required

plex_token stringrequired

Possible values: non-empty

Responses

200

application/json

Schema

Schema

flow_info

object

Contextual flow information for a challenge

title string

background string

cancel_url stringrequired

layout ContextualFlowInfoLayoutEnum (string)required

Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

component string
Default value: xak-flow-redirect

response_errors

object

property name*

object[]

Array [

string stringrequired

code stringrequired

]

to stringrequired

Example (from schema)

{
  "flow_info": {
    "title": "string",
    "background": "string",
    "cancel_url": "string",
    "layout": "stacked"
  },
  "component": "xak-flow-redirect",
  "response_errors": {},
  "to": "string"
}

400

Token not found

403

Access denied

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "/api/v3/sources/plex/redeem_token/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n  \"plex_token\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

slug — query

Body required

{
  "plex_token": "string"
}