SAMLSource.md

SAMLSource

SAMLSource 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]
pre_authentication_flow	UUID	Flow used before authentication.
issuer	str	Also known as Entity ID. Defaults the Metadata URL.	[optional]
sso_url	str	URL that the initial Login request is sent to.
slo_url	str	Optional URL if your IDP supports Single-Logout.	[optional]
allow_idp_initiated	bool	Allows authentication flows initiated by the IdP. This can be a security risk, as no validation of the request ID is done.	[optional]
name_id_policy	SAMLNameIDPolicyEnum	NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.	[optional]
binding_type	BindingTypeEnum		[optional]
verification_kp	UUID	When selected, incoming assertion's Signatures will be validated against this certificate. To allow unsigned Requests, leave on default.	[optional]
signing_kp	UUID	Keypair used to sign outgoing Responses going to the Identity Provider.	[optional]
digest_algorithm	DigestAlgorithmEnum		[optional]
signature_algorithm	SignatureAlgorithmEnum		[optional]
temporary_user_delete_after	str	Time offset when temporary users should be deleted. This only applies if your IDP uses the NameID Format 'transient', and the user doesn't log out manually. (Format: hours=1;minutes=2;seconds=3).	[optional]
encryption_kp	UUID	When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the the private key.	[optional]
signed_assertion	bool		[optional]
signed_response	bool		[optional]

Example

from authentik_client.models.saml_source import SAMLSource

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

# convert the object into a dict
saml_source_dict = saml_source_instance.to_dict()
# create an instance of SAMLSource from a dict
saml_source_from_dict = SAMLSource.from_dict(saml_source_dict)

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