Skip to content
Dashboard
Theme
Theme

AD FS SAML single sign-on

Set up SAML single sign-on with AD FS

View Markdown

Add a relying party trust in AD FS from our metadata, add claim rules that send the email address, and share your federation metadata with us.

The values in braces, such as {metadata_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. Add a relying party trust from our metadata

    Section titled “Add a relying party trust from our metadata”

    On the federation server, open Server Manager > Tools > AD FS Management. Under Actions, select Add Relying Party Trust, choose Claims aware and select Start. Choose “Import data about the relying party published online or on a local network”, paste {metadata_url} into Federation metadata address and select Next.

    Only for the metadata setup method.

    Paste into AD FS:

    • SP metadata URL: {metadata_url}

    Fixes: saml_destination_mismatch, saml_audience_mismatch, saml_response_malformed

  2. On the federation server, open Server Manager > Tools > AD FS Management. Under Actions, select Add Relying Party Trust, choose Claims aware and select Start. Choose “Enter data about the relying party manually”. On Configure URL, select “Enable support for the SAML 2.0 WebSSO protocol” and paste {acs_url} into Relying party SAML 2.0 SSO service URL. On Configure Identifiers, add {sp_entity_id}.

    Only for the manual setup method.

    Paste into AD FS:

    • ACS URL: {acs_url}
    • SP entity ID: {sp_entity_id}

    Fixes: saml_destination_mismatch, saml_audience_mismatch

  3. Enter a display name, choose an access control policy that lets your users in (for example Permit everyone), review the settings and finish the wizard.

    Fixes: saml_idp_status_error

  4. In the claim rules for the trust, add a rule that sends the LDAP attributes E-Mail-Addresses, Given-Name and Surname as E-Mail Address, Given Name and Surname, and a rule that transforms E-Mail Address into Name ID with the Email format.

    Fixes: saml_nameid_missing, saml_email_missing

  5. In the trust’s properties, on the Advanced tab, set the secure hash algorithm to SHA-256.

    Fixes: saml_signature_missing, saml_signature_algorithm_weak

  6. Add your AD FS federation metadata to this setup, usually https://your-adfs-host/FederationMetadata/2007-06/FederationMetadata.xml (or upload the file). Do this again whenever the token-signing certificate changes.

    Fixes: saml_signature_invalid, saml_issuer_mismatch

  7. Run a test sign-in in this setup, signing in with an account the access control policy allows.

If our main network ever has an outage, sign-ins can continue through a standby address, but only if AD FS accepts it. A relying party trust created from {metadata_url} already has it as a second SAML assertion consumer endpoint. If you entered the data manually, open the trust’s properties, and on the Endpoints tab add a SAML Assertion Consumer endpoint with binding POST, index 1 and URL {standby_acs_url}. Then confirm in this setup that you added it.

Paste into AD FS:

  • SP metadata URL: {metadata_url}
  • Standby ACS URL: {standby_acs_url}

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