Sign in
sources

Plex source Viewset

post/sources/plex/

Request body

namestring required

Source's display Name.

slugstring required

Internal source name, used in URLs.

enabledboolean
promotedboolean

When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

authentication_flowstring uuid nullable

Flow to use when authenticating existing users.

enrollment_flowstring uuid nullable

Flow to use when enrolling new users.

user_property_mappingsstring[]
group_property_mappingsstring[]
policy_engine_mode'all' | 'any'
user_matching_mode'identifier' | 'email_link' | 'email_deny' | 'username_link' | 'username_deny'
user_path_templatestring
iconstring
group_matching_mode'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_tokenstring required

Plex token used to check friends

Response

pkstring uuid required
namestring required

Source's display Name.

slugstring required

Internal source name, used in URLs.

enabledboolean
promotedboolean

When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

authentication_flowstring uuid nullable

Flow to use when authenticating existing users.

enrollment_flowstring uuid nullable

Flow to use when enrolling new users.

user_property_mappingsstring[]
group_property_mappingsstring[]
componentstring required

Get object component so that we know how to edit the object

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

policy_engine_mode'all' | 'any'
user_matching_mode'identifier' | 'email_link' | 'email_deny' | 'username_link' | 'username_deny'
managedstring nullable required

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
iconstring
icon_urlstring required
group_matching_mode'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_tokenstring required

Plex token used to check friends

Changes

No recorded changes to this endpoint across all 1 revision of this API.