Introduction

The SAML integration is for use with SSO platforms that support the "Security Assertion Markup Language" standard such as Okta, Auth0, and many other identity management platforms.

Via this integration, you can use your own identity provider to authenticate users that are configured within the Zype platform.

How to Use

To add the SAML integration, use the "Integrations" link in the navigation bar to access the Integrations Marketplace, and tap the "Add Integrations" button:

Tap the integration labeled "SAML Single Sign-On":

The integration's configuration form will be shown:

The setup instructions for each identity platform will be found with each platform's own documentation. Each platform will provide a "Metadata URL" and require the "Single Sign-On URL" and other configuration values that are provided on this form. Tap the "Copy to Clipboard" button for each value and paste the value in the appropriate configuration field within the identity provider's configuration screens.

Logging In

To use the SAML provider for login to the Zype Admin, first login to your identity provider and then access the provider's "application dashboard" or equivalent interface (each platform will provide its own interface for this, which typically provides an icon or other visual representation for each configured external service - Zype Admin, in this case). The identity provider will automatically route you to the Zype dashboard's SAML authentication URL, which will match your credentials with an existing user in the Zype platform.

NOTE: Users must be created within the Zype platform for authentication to succeed. The SAML integration does not remove the need to create users within the Zype platform and assign them roles. Once SAML setup is performed, the passwords associated with individual user accounts in the Zype platform may be retained or discarded per your preference. Users are not asked to provide this password when authenticating via the route described above.