Skip to content

Latest commit

 

History

History
57 lines (48 loc) · 3.81 KB

SAMLSourceRequest.md

File metadata and controls

57 lines (48 loc) · 3.81 KB

SAMLSourceRequest

SAMLSource Serializer

Properties

Name Type Description Notes
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]
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]
user_path_template str [optional]
icon str [optional]
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_request import SAMLSourceRequest

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

# convert the object into a dict
saml_source_request_dict = saml_source_request_instance.to_dict()
# create an instance of SAMLSourceRequest from a dict
saml_source_request_from_dict = SAMLSourceRequest.from_dict(saml_source_request_dict)

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