These instructions explain how to configure Auth0 to serve as an Identity Provider in a SAML federation.
1. Obtain Information from the Service Provider
You will need to obtain from the Service Provider (application) the URL to which the SAML Authentication Assertion should be sent. This may be called Assertion Consumer Service URL, the Post-back URL, or Callback URL.
2. Configure Auth0 as IDP
In this section you will configure Auth0 to serve as an Identity Provider. You will do this by registering an application and using an addon.
- Go to Dashboard > Applications.
- Click the + CREATE CLIENT button on the right.
- In the Name field, enter a name like
MySAMLApp, and select the application type.
- Click SAVE.
- Go back to Dashboard > Applications.
- Find the row for the application you just created, and click on the Settings icon to the right of the application name. (the round gear icon)
- Scroll down and click on the Advanced Settings link.
- In the expanded window, scroll down to the CERTIFICATES section and click on the DOWNLOAD CERTIFICATES button. In the popup which appears, select
PEMto select a PEM-formatted certificate. The certificate will be downloaded to a file called
YOUR_TENANT.pem. Save this file as you will need to upload it when you configure the Service Provider.
- Scroll down further to the ENDPOINTS section and click on SAML. Copy the contents of the SAML Protocol URL field and save it as you will need to provide it to the Service Provider.
- Scroll back up and click on the Addons tab. Then click on SAML2 WEB APP.
- In the Application Callback URL field, enter the URL of the Service Provider (or application) to which the SAML assertions should be sent after Auth0 has authenticated the user.
- In the Addon SAML2 Web App popup, click on the Usage tab. This tab will provide you with the information needed to configure the Service Provider application.
3. Configure the Service Provider
In this section you will add some information to the Service Provider so they know how to send SAML-based authentication requests to Auth0.
The instructions provided here are generic. You will need to find the appropriate screens and fields on the Service Provider.
If the Service Provider supports uploading a metadata file, you can simply provide the metadata URL obtained in the step above (Applications > Addons > Usage).
If the Service Provider does not support uploading a metadata file, you can configure it manually, using the information from the Auth0 Applications > Addons > Usage screen as follows:
- Identity Provider Login URL: This is the URL to which the Service Provider should send its SAML Authentication Requests.
Note that if you have custom domains set up, you should use the custom domain based URL rather than your Auth0 domain. So, instead of using a URL in the format of
https://[YOUR TENANT].auth0.com/samlp/CLIENTID?connection=Username-Password-Authentication you will want to use one in this format:
https://[YOUR CUSTOM DOMAIN]/samlp/CLIENTID?connection=Username-Password-Authentication.
If the Service Provider also has a field for a Logout URL, you can enter the same Identity Provider Login URL. Both login and logout are handled by the same URL.
The Service Provider will need a certificate from Auth0.
You can download this certificate from the Applications > Addons > Usage screen. This certificate will be used to validate the signature of the SAML Authentication Assertions sent from Auth0 to the Service Provider.
If the Service Provider asks for an Issuer, this can also be obtained from the same screen.
Once you have completed the above configuration, test the login.
If the Service Provider has been configured correctly, it should redirect the user browser to Auth0 for login. After authenticating the user, Auth0 should redirect the user browser back to the application.
This section has a few ideas for things to check if your sample doesn't work.
If your application doesn't work the first time, you should clear your browser history and ideally cookies each time before you test again. Otherwise, the browser may not be picking up the latest version of your html page or it may have stale cookies that impact execution.
When troubleshooting SSO, it is often helpful to capture an HTTP trace of the interaction. There are many tools that will capture the HTTP traffic from your browser for analysis. Search for
HTTP Traceto find some. Once you have an http trace tool, capture the login sequence from start to finish and analyze the trace to see the sequence of GETs to see how far in the expected sequence you get. You should see a redirect from the Service Provider to the Identity Provider, a post of credentials if you had to log in, and then a redirect back to the callback URL or the Service Provider application.
The http://samltool.io tool can decode a SAML assertion and is a useful debugging tool.