Security Assertion Markup Language (SAML) is an open standard that enables the exchange of security credentials between an identity provider and a service provider. This enables single sign on, allowing the use of one set of credentials (for each user) to login to many different websites and web services. SAML is generally used to increase security and enhance user experience.
- Click here to see a specific guide for setting up ADFS SAML
- Click here to see a specific guide for setting up Azure SAML.
Note: this feature is available with Enterprise licensing only.
Each user must login once to the single sign on with the identity provider. When the user tries to access the service provider, it sends an authorization and authentication request to the identity provider. The identity provider checks the user’s credentials and determines the whether the user is authorized to access the required service. If so, it sends a SAML assertion (an XML document) to the service provider, with the authorization and authentication messages.
To setup a SAML provider to work with Pyramid, provide the following settings
- Consumer URL: This will be the Pyramid web site address that will be "called" back by the SAML provider. Typically this should be "https://myPyramidsite.com"
- SAML Issuer: the access token or identifier will be provided from the SAML provider to confirm the incoming application is Pyramid
- IDP URL: this the SAML URL address - effectively the destination where the SAML request must be sent.
- Logout URL: the logout URL from the SAML provider
Active Directory Federation Services (ADFS): check this option to connect to ADFS. For more on ADFS click here.
The (Base64) certificate is a signed certificate provided by the SAML provider to allow Pyramid to decrypt the assertion messages coming in from the IDP. The certificate is provided by the SAML provider itself. This is CRITICAL.
This is the initial master user (from the SAML framework) that will be created by Pyramid.
- User Name: the internal user name of the initial user. This is a bypass for the user when working outside of SAML.
- Password: the internal password for the user. Only required if manually logging in without the SAML framework.
- First Name: the first name of the initial user
- Last Name: the last name of the initial user
- Email: the email of the initial user
- Principal Name: the SAML login ID of the initial user. This is the critical element that will enable Pyramid to match the incoming SAML assertion with the user account.
Once SAML authentication is configured, access to Pyramid can be completed through a SAML token exchange with the designated SAML provider.