Source.md

Source

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	Get the URL to the source icon	[readonly]
icon_themed_urls	ThemedUrls		[readonly]

Example

from authentik_client.models.source import Source

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

# convert the object into a dict
source_dict = source_instance.to_dict()
# create an instance of Source from a dict
source_from_dict = Source.from_dict(source_dict)

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