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

type ChallengeChoices (string)required

Possible values: [native, shell, redirect]

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)

{
  "type": "native",
  "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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST '/api/v3/sources/plex/redeem_token/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "plex_token": "string"
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

slug — query

Body required

{
  "plex_token": "string"
}