SAML SSO with Auth0¶

Step-by-step guide to integrate Faraday's SAML SSO with Auth0.

Prerequisites: Faraday commercial edition, Auth0 account with admin access. See SAML for general SAML configuration reference.

Configuration Summary¶

Replace <domain> with your Faraday server's FQDN throughout.

Step-by-Step Setup¶

Step 1 — Create an Auth0 Application¶

1. Navigate to Auth0 and sign in with your admin account.
2. In the left menu, go to Applications → Applications.
3. Click Create Application.
4. Enter a name for the application (e.g., "Faraday").
5. Optionally choose an application type.
6. Click Create.

Step 2 — Enable the SAML Addon¶

1. On your new application page, go to the Addons tab.
2. Turn on the SAML2 WEB APP addon.
3. The addon configuration page will appear.

Step 3 — Copy IdP Credentials¶

1. Click the Usage tab in the SAML addon configuration.

2. Copy the following values for Faraday configuration:

   Auth0 Field	Faraday Setting
   Issuer	identity_id (Identity ID)
   Identity Provider Login URL	sso_url (SSO URL)
   Identity Provider Certificate	idp_certificate (IdP Certificate — download the file)

Step 4 — Configure the Callback URL¶

1. Click the Settings tab in the SAML addon configuration.

2. Enter the Application Callback URL:

   https://<domain>/_api/saml/acs
   

3. Click Save.

Step 5 — Configure Application URIs¶

1. Back on your application page, go to the main Settings tab.
2. Scroll down to the Application URIs section.

3. Fill in the following:

   Field	Value
   Application Login URI	https://<domain>/_api/saml/login
   Allowed Logout URLs	https://<domain>/_api/saml/logout
   Allowed Web Origins	https://<domain>/
   Allowed Origins (CORS)	https://<domain>/

4. Scroll to the bottom and click Save Changes.

Step 6 — Generate SP Certificates¶

On your Faraday server, generate the Service Provider certificate pair:

openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 1825 -out certificate.pem

• certificate.pem → SP Certificate in Faraday settings
• key.pem → SP Private Key in Faraday settings

Step 7 — Configure Faraday¶

Apply the settings via CLI:

faraday-manage settings -a update saml

Fill in the prompts:

Alternatively, configure via the Web UI at Preferences → Authentication → SAML.

Step 8 — Restart Faraday¶

systemctl restart faraday-server

Step 9 — Test the Integration¶

1. Open the Faraday login page.
2. Click the SSO button labeled with your display_name.
3. Authenticate at Auth0.
4. Verify you are redirected back to Faraday with an active session.

Attribute Mapping¶

Auth0 sends SAML assertions containing user attributes. The attribute_identifier setting tells Faraday which attribute to use as the username.

Common Auth0 attributes:

To customize attributes in the SAML assertion, edit the Settings tab of the SAML2 WEB APP addon and modify the mappings object in the JSON configuration.