PlexSource.md

PlexSource

Plex Source Serializer

Properties

Name	Type	Description	Notes
pk	UUID		[readonly]
name	str	Source's display Name.
slug	str	Internal source name, used in URLs.
enabled	bool		[optional]
promoted	bool	When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.	[optional]
authentication_flow	UUID	Flow to use when authenticating existing users.	[optional]
enrollment_flow	UUID	Flow to use when enrolling new users.	[optional]
user_property_mappings	List[UUID]		[optional]
group_property_mappings	List[UUID]		[optional]
component	str	Get object component so that we know how to edit the object	[readonly]
verbose_name	str	Return object's verbose_name	[readonly]
verbose_name_plural	str	Return object's plural verbose_name	[readonly]
meta_model_name	str	Return internal model name	[readonly]
policy_engine_mode	PolicyEngineMode		[optional]
user_matching_mode	UserMatchingModeEnum	How the source determines if an existing user should be authenticated or a new user enrolled.	[optional]
managed	str	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.	[readonly]
user_path_template	str		[optional]
icon	str		[optional]
icon_url	str		[readonly]
icon_themed_urls	ThemedUrls		[readonly]
group_matching_mode	GroupMatchingModeEnum	How the source determines if an existing group should be used or a new group created.	[optional]
client_id	str	Client identifier used to talk to Plex.	[optional]
allowed_servers	List[str]	Which servers a user has to be a member of to be granted access. Empty list allows every server.	[optional]
allow_friends	bool	Allow friends to authenticate, even if you don't share a server.	[optional]
plex_token	str	Plex token used to check friends

Example

from authentik_client.models.plex_source import PlexSource

# TODO update the JSON string below
json = "{}"
# create an instance of PlexSource from a JSON string
plex_source_instance = PlexSource.from_json(json)
# print the JSON string representation of the object
print(PlexSource.to_json())

# convert the object into a dict
plex_source_dict = plex_source_instance.to_dict()
# create an instance of PlexSource from a dict
plex_source_from_dict = PlexSource.from_dict(plex_source_dict)

[Back to Model list] [Back to API list] [Back to README]