sources_plex_list

GET 
/api/v3//sources/plex/

Plex source Viewset

Request

Query Parameters

allow_friends boolean
authentication_flow uuid
client_id string
enabled boolean
enrollment_flow uuid
group_matching_mode string

Possible values: [identifier, name_deny, name_link]

How the source determines if an existing group should be used or a new group created.

name string
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

pbm_uuid uuid
policy_engine_mode string

Possible values: [all, any]

search string

A search term.

slug string
user_matching_mode string

Possible values: [email_deny, email_link, identifier, username_deny, username_link]

How the source determines if an existing user should be authenticated or a new user enrolled.

Responses

200

application/json

Schema

Schema

pagination objectrequired
nextnumberrequired
previousnumberrequired
countnumberrequired
currentnumberrequired
total_pagesnumberrequired
start_indexnumberrequired
end_indexnumberrequired
results object[]required
Array [
pkuuidrequired
namestringrequired
Source's display Name.
slugstringrequired
Internal source name, used in URLs.
Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$
enabledboolean
authentication_flowuuidnullable
Flow to use when authenticating existing users.
enrollment_flowuuidnullable
Flow to use when enrolling new users.
user_property_mappingsuuid[]
group_property_mappingsuuid[]
componentstringrequired
Get object component so that we know how to edit the object
verbose_namestringrequired
Return object's verbose_name
verbose_name_pluralstringrequired
Return object's plural verbose_name
meta_model_namestringrequired
Return internal model name
policy_engine_modePolicyEngineMode (string)
Possible values: [all, any]
user_matching_modeUserMatchingModeEnum (string)
How the source determines if an existing user should be authenticated or a new user enrolled.
Possible values: [identifier, email_link, email_deny, username_link, username_deny]
managedManaged by authentik (string)nullablerequired
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
user_path_templatestring
iconstringrequired
group_matching_modeGroupMatchingModeEnum (string)
How the source determines if an existing group should be used or a new group created.
Possible values: [identifier, name_link, name_deny]
client_idstring
Client identifier used to talk to Plex.
allowed_serversstring[]
Which servers a user has to be a member of to be granted access. Empty list allows every server.
allow_friendsboolean
Allow friends to authenticate, even if you don't share a server.
plex_tokenstringrequired
Plex token used to check friends
]

Example (auto)

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "slug": "string",
      "enabled": true,
      "authentication_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "enrollment_flow": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "user_property_mappings": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "group_property_mappings": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "component": "string",
      "verbose_name": "string",
      "verbose_name_plural": "string",
      "meta_model_name": "string",
      "policy_engine_mode": "all",
      "user_matching_mode": "identifier",
      "managed": "string",
      "user_path_template": "string",
      "icon": "string",
      "group_matching_mode": "identifier",
      "client_id": "string",
      "allowed_servers": [
        "string"
      ],
      "allow_friends": true,
      "plex_token": "string"
    }
  ]
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "detail": "string",
  "code": "string"
}

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.Get, "/api/v3/sources/plex/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
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

allow_friends — query

---truefalse

authentication_flow — query

client_id — query

enabled — query

---truefalse

enrollment_flow — query

group_matching_mode — query

---identifiername_denyname_link

name — query

ordering — query

page — query

page_size — query

pbm_uuid — query

policy_engine_mode — query

---allany

search — query

slug — query

user_matching_mode — query

---email_denyemail_linkidentifierusername_denyusername_link