Skip to main content

sources_plex_create

POST 
/sources/plex/

Plex source Viewset

Request​

Body

required

    name stringrequired

    Source's display Name.

    Possible values: non-empty

    slug stringrequired

    Internal source name, used in URLs.

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    enabled boolean
    authentication_flow uuidnullable

    Flow to use when authenticating existing users.

    enrollment_flow uuidnullable

    Flow to use when enrolling new users.

    user_property_mappings uuid[]
    group_property_mappings uuid[]
    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    user_matching_mode UserMatchingModeEnum (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_template string

    Possible values: non-empty

    group_matching_mode GroupMatchingModeEnum (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_id string

    Client identifier used to talk to Plex.

    Possible values: non-empty

    allowed_servers string[]

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

    Possible values: non-empty

    allow_friends boolean

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

    plex_token stringrequired

    Plex token used to check friends

    Possible values: non-empty

Responses​

Schema

    pk uuidrequired
    name stringrequired

    Source's display Name.

    slug stringrequired

    Internal source name, used in URLs.

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    enabled boolean
    authentication_flow uuidnullable

    Flow to use when authenticating existing users.

    enrollment_flow uuidnullable

    Flow to use when enrolling new users.

    user_property_mappings uuid[]
    group_property_mappings uuid[]
    component stringrequired

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

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    user_matching_mode UserMatchingModeEnum (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]

    managed Managed 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_template string
    icon stringrequired
    group_matching_mode GroupMatchingModeEnum (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_id string

    Client identifier used to talk to Plex.

    allowed_servers string[]

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

    allow_friends boolean

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

    plex_token stringrequired

    Plex token used to check friends

Loading...