---
title: "General SAML 2.0 SSO Setup"
canonical: "https://help.agiloft.com/space/HELP/65243366/General+SAML+2.0+SSO+Setup"
format: markdown
---
If you don’t use Okta, Microsoft Entra, Ping, CyberArk, or Salesforce for identity and access management, you can use this article for general guidance on setting up single sign-on (SSO) with any SAML 2.0 Identity Provider (IdP). This article also includes instructions on how to log in with SSO after the integration and make sure other users log in with SSO as well.

For specific setup instructions with popular IdPs, refer to these articles instead:

- [Okta SAML 2.0 SSO Setup](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43716924)
- [Microsoft Entra SAML 2.0 SSO Setup](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43715708)
- [Ping Identity SAML 2.0 SSO Setup](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43714348)
- [CyberArk SAML 2.0 SSO Setup](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43718200)
- [Salesforce SAML 2.0 SSO Setup](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43715780)

> 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 Your IdP](#configure_idp) for instructions on setting up your IdP.

## > Macro (anchor)

Configure Your IdP

Before you can complete the Agiloft setup, you need to integrate Agiloft as a SAML service provider in your IdP. Refer to your provider’s documentation for instructions.

To download the SAML Service Provider Metadata XML file from Agiloft so you can import it to your IdP, follow these steps:

1. In Agiloft, go to **Setup > Access > Configure SAML 2.0 Profiles**.
2. Select the profile for your IdP, then click Download Metadata XML. The file includes the X.509 certificate.

Once your IdP is configured, download the SAML metadata XML from your IdP and return to Agiloft. If you want to configure SAML provisioning, continue to [Configure User Group, Team, and Fields Mapping](#) below. Otherwise, proceed to [Configure Identity Provider Details](#).

## > Macro (anchor)

Configure User Group, Team, and Fields Mapping

In order to create or update user records on successful SAML logins, you need to map SAML attributes from your IdP to fields in Agiloft CLM. Follow the steps below to configure attribute to field mappings.

> ℹ️ User data, like First Name, Last Name, and Email, defined directly in the People table or its subtables can be added or changed based on SAML attributes. User records and field values don't have to pre-exist in the system. Group and team values can also be assigned from attributes. However, groups and teams aren't defined in the People table. They are linked fields to the privileged Groups and Teams tables, which can't be updated via SAML. When Agiloft reads group or team attributes, it looks for an exact match in the corresponding table. If there isn't a match, the user gets an error and can't log in. If you want to set groups or teams from attributes, you must add those groups or teams to Agiloft first, or users won't be able to log in with SAML.

1. Go to **Setup > Access > Configure SAML 2.0 Profiles** and edit the profile for this Idp.
2. Go to the User Group Mapping tab.
3. Choose the method for group assignment:
  - If you want to assign all SAML users to an existing Agiloft group, select "Choose a Group existing in Agiloft as the default Group for the user" and choose the group from the drop-down list.
  - If you want to assign users to existing groups in Agiloft based on a SAML attribute, select "Map the group(s) from this SAML Attribute" and enter the attribute to use.

> 📝 Any group values you send have to exactly match a Group Name in the Groups table before users in those groups can log in with SAML.

4. Next, define what to do on subsequent logins:
  - If you want to update a user's group details every time the user logs in, select "Update user's group based on the selection above."
  - If you want don't want to update groups once they're set, select "Do not update user's group membership in Agiloft."
5. Click Next to set up team mappings.
6. On the User Team Mapping tab, choose the method for team assignment:
  - If you want to assign all SAML users to existing primary and secondary teams in Agiloft, select Set the User’s teams from Agiloft. Then select the Primary Team from the drop-down list. To assign secondary teams, select a team from the Teams list. Hold Ctrl and click to select any number of secondary teams.
  - If you want to assign users to existing teams in Agiloft based on SAML attributes, select Set the User’s teams from the IdP. Then enter the attributes to use for primary and secondary team assignments.

> 📝 Any team values you send have to exactly match a Team Name in the Teams table before users in those teams can log in with SAML.

7. Next, define what to do on subsequent logins:
  - If you want to update a user's team details every time the user logs in, select "Update their Primary Team and Teams fields based on the selection above."
  - If you want don't want to update teams once they're set, select "Do not update user's Primary Team and Teams fields in Agiloft based on selection above."
8. Click Next to go to the User Field Mapping tab. The tab lists the fields from user records that can be updated with values from SAML attributes.
9. On the User Field Mapping tab, supply the attributes for the fields you want to update in user records. Leave blank the ones you don't want to update.

> ⚠️ The Login field is mapped on the Server Provider Details tab. Do not map Login on this tab.

10. When attribute mapping is complete, click Next.

Now that user, group, and team mappings are configured, proceed to [Configure Identity Provider Details](#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)