Skip to main content

sources_plex_update

PUT 
/api/v3//sources/plex/:slug/

Plex source Viewset

Request​

Path Parameters

    slug stringrequired

Bodyrequired

    namestringrequired

    Source's display Name.

    Possible values: non-empty

    slugstringrequired

    Internal source name, used in URLs.

    Possible values: non-empty and <= 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[]
    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]

    user_path_templatestring

    Possible values: non-empty

    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.

    Possible values: non-empty

    allowed_serversstring[]

    Which servers a user has to be a member of to be granted access. Empty list allows every server.

    Possible values: non-empty

    allow_friendsboolean

    Allow friends to authenticate, even if you don't share a server.

    plex_tokenstringrequired

    Plex token used to check friends

    Possible values: non-empty

Responses​

Schema
    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

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "/api/v3/sources/plex/:slug/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"enabled\": true,\n  \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"enrollment_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"user_property_mappings\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"group_property_mappings\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"policy_engine_mode\": \"all\",\n  \"user_matching_mode\": \"identifier\",\n  \"user_path_template\": \"string\",\n  \"group_matching_mode\": \"identifier\",\n  \"client_id\": \"string\",\n  \"allowed_servers\": [\n    \"string\"\n  ],\n  \"allow_friends\": true,\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
Parameters
— pathrequired
Body required
{
  "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"
  ],
  "policy_engine_mode": "all",
  "user_matching_mode": "identifier",
  "user_path_template": "string",
  "group_matching_mode": "identifier",
  "client_id": "string",
  "allowed_servers": [
    "string"
  ],
  "allow_friends": true,
  "plex_token": "string"
}