Skip to content

Getting Started

If you're unfamiliar with SAML SSO, please refer to the SAML Technical Overview.

For most users, we recommend the following sequence:

  1. Install the product.
  2. Run the example projects.
  3. Configure SAML for your application.
  4. Enable SSO and SLO flows using the SAML API.

Installing the Product

Refer to the Installation section for the steps required to install the product for use with the examples and your applications.

Running the Examples

It's recommended that you run the example projects included with the product to see SAML SSO in action and to become familiar with the SAML configuration and API.

These examples are also useful for initial testing of your own SAML-enabled applications.

The Examples section lists the available example projects.

Understanding SAML Configuration

SAML configuration is used to specify information about the local provider and one or more partner providers. This information is used by the SAML API to support SAML SSO and SLO.

The Configuration section details the various SAML configuration settings.

Understanding SAML Metadata

SAML metadata is a standard XML format for exchanging configuration information between identity providers and service providers.

Although optional, its use is recommended.

The Metadata section describes how to generate, import and export metadata.

Understanding the SAML API

The API reference section describes the available SAML APIs and how to support SSO and SLO flows when acting as either a service provider or identity provider.

Managing X.509 Certificates

X.509 certificates are used to secure SAML SSO and SLO flows through XML signatures, XML encryption, and transport-layer security.

The Certificates section describes the management of these certificates.

Integrating with a Partner Provider

The Step-by-Step Guide - Service Provider section walks you through the recommended steps for enabling your web application to act as a service provider.

The Step-by-Step Guide - Identity Provider section walks you through the recommended steps for enabling your web application to act as an identity provider.

Need Help?

Please see our support forum or contact us at [email protected] if you have any questions or need assistance.