This feature is self-hosted/on-premises only
If you are using a self-hosted/on-premises deployment and would like to set up single sign-on (SAML 2,.0) follow the below instructions.
Whether you’re using a docker-compose or a Kubernetes deployment, introduce the following environment variable:
saml/saml.properties file contains all the configuration keys necessary to the SAML functionality.
onelogin.saml2.sp.entityid: identifies the SP
onelogin.saml2.sp.assertion_consumer_service.url: where the response from idp is returned after an authentication request
onelogin.saml2.sp.single_logout_service.url: where the response from idp is returned after logout request
onelogin.saml2.idp.single_sign_on_service.url: where the SP will send the Authentication Request
onelogin.saml2.idp.single_logout_service.url: where the SP will send the logout request
x509certificate of the IdP
Further changes can be applied to the expected properties:
In IDP one of MANAGER,DEVELOPER,ANALYST:
By altering these configuration keys, you change the name of the property that’s being sent by the IDP. As a default, the required properties are:
MAIL, and LEVEL (which represents the level of the user within API Fortress and can be one of the following values: MANAGER, DEVELOPER, or ANALYST. If the field is not provided, MANAGER is assumed.
The admin status can only be set via the API Fortress configuration panel.)
Note: there may be other configuration keys to be altered based on the IDP requirements.
Mount the provided "saml" directory to the location:
If Kubernetes is being used, ConfigMaps will achieve the same result.
Restart the API Fortress dashboard(s).
The login screen will now look like this: