SAML Settings
This document explains the functionality of the SAML feature as well as how to set up a SAML to log in to the platform without using email/password credentials.
About SAML
The platform supports single sign-on (SSO) authentication, which enables administrative users to log in to applications quickly and securely in a single session, without the need to use additional passwords.
How to Configure SAML
From the main menu, go to Company > Company Settings > SAML Settings and then click the + NEW button to create a new SAML configuration.
The details of the SAML configuration edit page are provided in the table below.
Configuration Details
SAML Name | Name of the SAML configuration |
Allowed Domains | Domain names authorized for SSO use |
SAML Configuration For Platform
The information that has been provided by the identity provider must be defined to the platform.
Upload Metadata | Metadata provided by the identity provider can be used to automatically complete required fields. |
Issuer URL of the IdP | URL information that must be provided manually if not uploaded in the metadata file |
IdP SSO URL | Authentication address that must be provided manually if not uploaded in the metadata file |
Upload Certificate | Certificate to be used for authentication if not uploaded in the metadata file |
IdP Certificate | If the certificate file for validation couldn’t be uploaded, the certificate can be written as text in this field. |
SAML Configuration For Your Identity Provider
The information that has been provided by the platform must be defined to the identity provider.
Download Metadata | Metadata file containing all of the required information. The file can be used by the identity provider to get all required information automatically. |
Idp Entity ID | If the identity provider doesn’t allow a metadata file to be uploaded, Idp Entity ID information can be defined from this field. |
SSO Sign-in URL | If the authenticator service does not allow a metadata file to be uploaded, the SSO login page URL address information can be defined from this field. |
Metadata URL | URL address of the metadata file containing all of the information required by the identity provider. |
Bypass SSO Login URL | The URL address can be used to log in to the platform without SSO. |
SAML Attributes Mapping | The attributes given in this field should be mapped on the identity provider and must be matched. |
Default Role | Permission level of users who will log in to the system for the first time using SSO |
Enable SAML SSO | The SAML setting can be inactivated if there is no more SSO use needed. |
The privileges of the automatic account generated for admins who log in to the system using SSO can be defined in the Default Role field. The Custom Roles can be created to restrict the privileges, please see more here.
SAML Integration Documents
The SAML integration documents for most used identity providers are listed below to assist admins to set up SAML between their identity provider and platform successfully.
FAQ
Q: An admin can't login to platform over SAML and sees a "Your account not registered..." message.
A: The admin email address must be created in the platform under the Company > System Users page in order to log in to the platform over SAML authentication.
Last updated