Skip to content

SAML API

The SAML API supports web applications acting as either a SAML service provider (SP) or identity provider (IdP), and participating in SAML single sign-on (SSO) and single logout (SLO).

For full details of all public APIs, refer to the API reference.

Initialization

The default initialization automatically loads the SAML configuration from the saml.config file in the application's root folder.

Refer to the Configuration section for more options.

SamlServiceProvider

The SamlServiceProvider supports SAML SSO and SLO when acting as the service provider.

SamlIdentityProvider

The SamlIdentityProvider supports SAML SSO and SLO when acting as the identity provider.