---
title: "Legacy AD FS SAML 2.0 SSO Setup"
canonical: "https://help.agiloft.com/space/HELP/43718538/Legacy+AD+FS+SAML+2.0+SSO+Setup"
format: markdown
---
This article provides instructions for setting up SAML 2.0 single sign-on (SSO) with Active Directory Federation Services (2.0 or 3.0) as the Identity Provider (IdP). It also includes instructions on how to log in with SSO after the integration and make sure other users log in with SSO as well.

> Macro (include)

# Set Up SAML 2.0 SSO

> Macro (include)

## > Macro (anchor)

Create a SAML SSO Profile

> Macro (include)

## > Macro (anchor)

Configure Service Provider Details

> Macro (include)

At this point, you can't finish the setup in Agiloft until you configure your IdP. Continue to [Configure AD FS](#configure_idp) for instructions on setting up your IdP.

## > Macro (anchor)

Configure AD FS

Follow the steps below to add Agiloft as a SAML service provider in AD FS.

> ℹ️ These are general steps for configuring AD FS. If the options you see in the management console or your practices for adding a service provider differ from those described here, refer to Microsoft's [documentation](https://msdn.microsoft.com/en-us/library/bb897402.aspx?f=255&MSPPError=-2147217396) on Active Directory Federation Services to complete the task.

1. First, to streamline the AD FS setup, download the SAML Service Provider Metadata XML file from Agiloft so you can import it to AD FS:
  1. In Agiloft, go to **Setup > Access > Configure SAML 2.0 Profiles**.
  2. Select the profile for this IdP, then click Download Metadata XML. The file includes the X.509 certificate.
2. Now, open the [AD FS Management Console](https://technet.microsoft.com/en-us/library/gg557729%28v=ws.10%29.aspx?f=255&MSPPError=-2147217396) in your Windows Server instance.
3. Select the Relying Party Trusts folder and add a new Standard Relying Party Trust from the Actions sidebar.
  1. On the Select Data Source screen, select the second option and upload the Agiloft SP Metadata XML file.
  2. On the next screen, enter a Display name, such as SKS-Agiloft SAML.
  3. On the next screen, select the AD FS profile radio button.
  4. On the next screen, choose whether to configure multi-factor authentication.
  5. On the next screen, select Permit all users to access this relying party.
  6. On the next two screens, the wizard displays an overview of your settings.
  7. On the final screen, click Close.
4. Once the relying party trust has been created, create claim rules and update the Relying Party Trust (RPT) with minor changes that aren't set by the wizard. By default, the Claim Rule editor opens once the trust has been created.
5. To create a new rule, click on Add Rule and create a Send LDAP Attributes as Claims rule.
6. On the next screen, using Active Directory as your attribute store, do the following:
  1. In the LDAP Attribute column, select E-mail Addresses.
  2. In the Outgoing Claim Type, select E-mail Address.
  3. Click OK to save the new rule.
7. Create another new rule by clicking Add Rule, this time selecting Transform an Incoming Claim as the template.
8. On the next screen:
  1. Select E-mail Address as the Incoming Claim Type.
  2. For Outgoing Claim Type, select Name ID.
  3. For Outgoing Name ID Format, select Email.
  4. You need to modify the signing algorithm on your relying party trust. Select Properties from the Actions sidebar while you have the RPT selected.
  5. On the Advanced tab, confirm that SHA-256 is selected. On versions of Agiloft prior to release 26, change this setting to SHA-1.
9. Once the relying party trust has been created, you can create the claim rules and update the RPT with minor changes that aren't set by the wizard. By default, the claim rule editor opens once you create the trust. You can configure additional claim rules.
10. Confirm the changes by clicking OK on the endpoint and the RPT properties.
11. Next, make a settings adjustment using PowerShell:
  1. Run the following AD FS PowerShell command:
  2. If you're using AD FS 3.0 or later, you're finished. If you're using AD FS 2.0, use Remote Desktop (RDP) to access the AD system:
    1. In the RDP, open PowerShell.
    2. Add Windows PowerShell snap-ins to the current session.
12. Finally, locate the Federation Metadata XML file on your server and copy its contents to a note so you can refer to it later. You use the contents of this file to configure the identity provider details in Agiloft.

Now that AD FS is configured, return to Agiloft. If you want to configure SAML attribute to Agiloft field mappings, continue to [Configure User Group, Team, and Fields Mapping](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43718538/Legacy+AD+FS+SAML+SSO#LegacyADFSSAMLSSO-mapping) below. If you don't want to configure mappings, proceed to [Configure Identity Provider Details](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43718538/Legacy+AD+FS+SAML+SSO#LegacyADFSSAMLSSO-identity_provider).

## > Macro (anchor)

Configure User Group, Team, and Fields Mapping

> Macro (include)

### > Macro (anchor)

SAML Attribute Mapping

The table below lists some of the default SAML attributes that AD FS sends in the SAML response.

| **Attributes sent by Entra** | **Value** | **Field Mapping in Agiloft** |
| --- | --- | --- |
| http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier | user.userprincipalname [nameid-format:emailAddress] | Mapped in Service Provider Details |
| http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname | user.givenname | First Name |
| http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname | user.surname | Last Name |
| http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress | user.mail | Email Address |

> ℹ️ The nameidentifier attribute is the NameID that is mapped on the [Service Provider Details](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43718538/Legacy+AD+FS+SAML+SSO#LegacyADFSSAMLSSO-service_provider) tab. The default format in this instance is emailAddress.

To map the attributes to fields in Agiloft, enter the attributes in the relevant field names on the User Field(s) Mapping tab.

![User Field Mappings](media://bbb8799b-8b1a-46f3-9d27-7ccc6a2fbf65)

Now that user, group, and team mappings are configured, proceed to [Configure Identity Provider Details](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43718538/Legacy+AD+FS+SAML+SSO#LegacyADFSSAMLSSO-identity_provider) to complete the SAML SSO setup.

## > Macro (anchor)

Configure Identity Provider Details

> Macro (include)

# > Macro (anchor)

Log in with SAML

> Macro (include)

# > Macro (anchor)

Force SSO Login

> Macro (include)

# > Macro (anchor)

Generating a Key Pair

> Macro (include)

> Macro (hide-if)
> 
> #### Related Articles
> 
> > Macro (contentbylabel)