POST /providers/wsfed — authentik

providers

WSFederationProvider Viewset

post/providers/wsfed/

Request body

namestring required

authentication_flowstring uuid nullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flowstring uuid required

Flow used when authorizing this provider.

invalidation_flowstring uuid required

Flow used ending the session from a provider.

property_mappingsstring[]

reply_urlstring uri required

wtrealmstring required

assertion_valid_not_beforestring

Assertion valid not before current time + this value (Format: hours=-1;minutes=-2;seconds=-3).

assertion_valid_not_on_or_afterstring

Assertion not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

session_valid_not_on_or_afterstring

Session not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

name_id_mappingstring uuid nullable

Configure how the NameID value will be created. When left empty, the NameIDPolicy of the incoming request will be considered

authn_context_class_ref_mappingstring uuid nullable

Configure how the AuthnContextClassRef value will be created. When left empty, the AuthnContextClassRef will be set based on which authentication methods the user used to authenticate.

saml_version'1.1' | '2.0'

digest_algorithm'http://www.w3.org/2000/09/xmldsig#sha1' | 'http://www.w3.org/2001/04/xmlenc#sha256' | 'http://www.w3.org/2001/04/xmldsig-more#sha384' | 'http://www.w3.org/2001/04/xmlenc#sha512'

signature_algorithm'http://www.w3.org/2000/09/xmldsig#rsa-sha1' | 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256' | 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha384' | 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha512' | 'http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1' | 'http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256' | 'http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha384' | 'http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha512' | 'http://www.w3.org/2000/09/xmldsig#dsa-sha1'

signing_kpstring uuid nullable

Keypair used to sign outgoing Responses going to the Service Provider.

encryption_kpstring uuid nullable

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.

sign_assertionboolean

sign_logout_requestboolean

default_name_id_policy'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress' | 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent' | 'urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName' | 'urn:oasis:names:tc:SAML:2.0:nameid-format:WindowsDomainQualifiedName' | 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient' | 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'

Response

pkinteger required

namestring required

authentication_flowstring uuid nullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flowstring uuid required

Flow used when authorizing this provider.

invalidation_flowstring uuid required

Flow used ending the session from a provider.

property_mappingsstring[]

componentstring required

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

assigned_application_slugstring nullable required

Internal application name, used in URLs.

assigned_application_namestring nullable required

Application's display Name.

assigned_backchannel_application_slugstring nullable required

Internal application name, used in URLs.

assigned_backchannel_application_namestring nullable required

Application's display Name.

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name