Skip to content
Dashboard
Theme
Theme

Auth0 SAML single sign-on

Set up SAML single sign-on with Auth0

View Markdown

Create a SAML 2.0 app in Auth0, paste the values from this setup, assign your users and share the identity provider metadata with us.

The values in braces, such as {acs_url}, are specific to your connection. The setup link from the application you are connecting shows them with a copy button. The same steps appear there.

  1. In the admin console of Auth0, create a new SAML 2.0 application for this app. Auth0 may call it a custom app, a service provider or a relying party. Give it a name your users will recognize.

  2. Paste {acs_url} into the assertion consumer service (ACS) URL field, which may be labelled single sign-on URL or reply URL. If the app also has recipient or destination fields, use the same value there.

    Paste into Auth0:

    • ACS URL: {acs_url}

    Fixes: saml_destination_mismatch, saml_response_malformed

  3. Paste {sp_entity_id} into the service provider entity ID field, which may be labelled audience, audience URI or identifier.

    Paste into Auth0:

    • SP entity ID: {sp_entity_id}

    Fixes: saml_audience_mismatch

  4. Send a value that never changes for a user as the name ID, such as the user ID or the email address. Auth0 sends the unspecified name ID format by default, which works.

    Fixes: saml_nameid_missing

  5. Make sure Auth0 signs the SAML response, the assertion or both, and uses SHA-256 (RSA-SHA256) as the signature algorithm.

    Fixes: saml_signature_missing, saml_signature_algorithm_weak

  6. Add attributes named http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress with the email address, http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname with the first name and http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname with the last name.

    Fixes: saml_email_missing

  7. Assign the people or groups who should sign in to this app with single sign-on.

    Fixes: saml_idp_status_error

  8. Copy the app’s SAML metadata URL, which has the form “https://your-tenant-domain/samlp/metadata/your-client-id”, and add it to this setup. If you can only download the file, upload it here instead and do this again whenever the signing certificate changes.

    Fixes: saml_signature_invalid, saml_issuer_mismatch

  9. Run a test sign-in in this setup, signing in as a user you assigned to the app.

If our main network ever has an outage, sign-ins can continue through a standby address, but only if Auth0 accepts it. If the app’s SAML settings take more than one ACS URL, add {standby_acs_url} as a second one and confirm in this setup that you added it. If they take only one, skip this step.

Paste into Auth0:

  • Standby ACS URL: {standby_acs_url}

This step is optional. See standby route behavior for what the standby address does during an outage.