Files
authentik/website/docs/add-secure-apps/providers/saml/index.md
Tana M Berry 9a89a5f94b website: latest migration to new structure (#11522)
* first pass

* dependency shenanigans

* move blueprints

* few broken links

* change config the throw errors

* internal file edits

* fighting links

* remove sidebarDev

* fix subdomain

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix relative URL

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix mismatched package versions

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix api reference build

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* test tweak

* links hell

* more links hell

* links hell2

* yep last of the links

* last broken link fixed

* re-add cves

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* add devdocs redirects

* add dir

* tweak netlify.toml

* move latest 2 CVES into dir

* fix links to moved cves

* typoed title fix

* fix link

* remove banner

* remove committed api docs

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* integrations: remove version dropdown

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* Update Makefile

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* change doc links in web as well

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* fix some more docs paths

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* fix more docs paths

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* ci: require ci-web.build for merging

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>

* Revert "ci: require ci-web.build for merging"

This reverts commit b99a4842a9.

* remove sluf for Application

* put slug back in

* minor fix to trigger deploy

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
Co-authored-by: Tana M Berry <tana@goauthentik.com>
Co-authored-by: Jens Langhammer <jens@goauthentik.io>
Co-authored-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
2024-10-08 14:07:19 -05:00

2.7 KiB

title
title
SAML Provider

This provider allows you to integrate enterprise software using the SAML2 protocol. It supports signed requests and uses property mappings to determine which fields are exposed and what values they return. This makes it possible to expose vendor-specific fields. Default fields are exposed through auto-generated Property Mappings, which are prefixed with "authentik default".

Endpoint URL
SSO (Redirect binding) /application/saml/<application slug>/sso/binding/redirect/
SSO (POST binding) /application/saml/<application slug>/sso/binding/post/
SSO (IdP-initiated login) /application/saml/<application slug>/sso/binding/init/
SLO (Redirect binding) /application/saml/<application slug>/slo/binding/redirect/
SLO (POST binding) /application/saml/<application slug>/slo/binding/post/
Metadata Download /application/saml/<application slug>/metadata/

You can download the metadata through the Webinterface, this link might be handy if your software wants to download the metadata directly.

The metadata download link can also be copied with a button on the provider overview page.

Name ID

You can select a custom SAML Property Mapping after which the NameID field will be generated. If left default, the following checks are done:

  • When the request asks for urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, the NameID will be set to the hashed user ID.

  • When the request asks for urn:oasis:names:tc:SAML:2.0:nameid-format:X509SubjectName, the NameID will be set to the user's distinguishedName attribute. This attribute is set by the LDAP source by default. If the attribute does not exist, it will fall back the persistent identifier.

  • When the request asks for urn:oasis:names:tc:SAML:2.0:nameid-format:WindowsDomainQualifiedName, the NameID will be set to the user's UPN. This is also set by the LDAP source, and also falls back to the persistent identifier.

  • When the request asks for urn:oasis:names:tc:SAML:2.0:nameid-format:transient, the NameID will be set based on the user's session ID.

  • When the request asks for urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, the NameID will be set to the user's email address.

    :::warning Keep in mind that with the default settings, users are free to change their email addresses. As such it is recommended to use urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, as this cannot be changed. :::