---
title: "Manage SSO"
canonical: "https://help.agiloft.com/space/HELP/971898905/Manage+SSO"
format: markdown
---
This article provides guidance on managing your existing SSO configurations in Agiloft CLM when your identity management infrastructure changes, such as when a certificate expires or you change your identity provider (IdP). For setup instructions, see [SAML 2.0 SSO](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43715776).

# > Macro (anchor)

Replacing the SAML Certificate

If you generate a new SAML certificate for the Agiloft CLM application in your IdP, the most efficient and least error-prone way to update the certificate in your KB is to replace the entire contents of the Identity Provider Details tab with the latest version of the IdP SAML metadata XML. Follow the steps below to update the identity provider details.

1. If necessary, download or copy the contents of the latest SAML metadata XML file from your IdP.
2. Open the metadata file in a text editor and copy all of its contents.
3. In Agiloft CLM, go to **Setup > Access > Configure SAML 2.0 Profiles** and edit the profile for the IdP whose certificate you want to replace.
4. Go to the Identity Provider Details tab.
5. Clear the value from every field on the tab.
6. Paste the copied metadata contents into the "SAML Metadata XML contents obtained from your IdP" text box.
7. Leave the remaining fields blank and click Finish. Agiloft CLM populates the rest of the fields based on the XML contents.
8. Test the updated configuration by logging in with SAML SSO.

# > Macro (anchor)

Disabling SSO Access for an IdP

If you need to turn off SSO access for an IdP, you can disable or delete the provider's profile. See [Disable a SAML Provider](#disable_saml) or [Disable an OAuth Provider](#disable_oauth) for instructions.

## > Macro (anchor)

Disable a SAML Provider 

For SAML providers, you can disable a profile and retain the configuration, making it easy to enable in the future. To disable a SAML profile:

1. Go to **Setup > Access > Configure SAML 2.0 Profiles**.
2. Select the profile you want to disable and click Disable in the action bar.

To reenable a provider, select the profile and click Enable. To permanently remove an IdP, select the profile you want to remove and click Delete.

## > Macro (anchor)

Disable an OAuth Provider

To disable access for an OAuth provider, you must delete the provider's profile:

1. Go to **Setup > Access > Configure OAuth 2.0 Profiles**.
2. Select the profile you want to remove and click Delete in the action bar.

# Switching to a New IdP

When switching to a new identity provider (IdP), you register Agiloft CLM as a service provider in the new IdP and then change your SSO profile in Agiloft CLM to point to the new provider. See [Replace a SAML Provider](#replace_saml_idp) or [Replace an OAuth Provider](#replace_oauth_idp) for instructions.

## > Macro (anchor)

Replace a SAML Provider

There are two ways to replace a SAML IdP: update your existing SAML profile with the new IdP details, or set up multiple SAML profiles. In most cases, we recommend updating the existing SAML profile. This keeps the SSO entry URL and existing hotlinks valid, so the transition is seamless for users who log in with SSO. Use multiple SAML profiles only if you need to keep both providers available during the changeover.

- **Update the existing SAML profile**: This is the simpler option and is recommended for most IdP changes. With this method:
  - The SSO entry URL remains the same.
  - Hotlinks continue to work without changes.
  - Users don’t need to complete a separate login with the new provider before using SSO links.
- **Use multiple SAML profiles**: Use this option only if you need to keep the current IdP active for a period of time after enabling the new provider. This method is more complex to implement and comes with important caveats. To preserve the existing SSO entry URL and hotlinks, you must update the existing profile to point to the new provider and create a new profile for the old provider. Otherwise, switching to the new IdP has the following effects:
  - The SSO entry URL changes, so you need to send users the new URL.
  - Hotlinks created before the switch stop working.
  - SSO users must log in to Agiloft CLM and authenticate with the new provider before autologin links work for them.

To follow the recommended approach and update the existing SAML profile, follow these steps:

1. First, if you haven’t done so already, register Agiloft CLM as a service provider in the new IdP:
  1. To download the SAML Service Provider Metadata XML file from Agiloft CLM so you can import it to your IdP, go to **Setup > Access > Configure SAML 2.0 Profiles**, select the checkbox next to the profile, and click Download Metadata XML. The file includes the X.509 certificate.
  2. Follow your IdP’s instructions to upload the service provider metadata and register Agiloft CLM as a service provider.
  3. After Agiloft CLM is registered, download or save to a file the SAML metadata XML from your IdP so you can upload it to your KB.
2. Go back to **Setup > Access > Configure SAML 2.0 Profiles**.
3. Edit the existing SAML profile and go to the Identity Provider Details tab.

> 📝 Before you make changes, you might want to copy the entire contents of the “SAML Metadata XML contents obtained from your IdP” field to a backup file in case you need to re-enable this provider in the future.

4. On the Identity Provider Details tab, clear the values in all of the fields.
5. Now, copy the entire contents of the SAML metadata XML from your IdP.

> 📝 Some IdPs provide an XML file for download and others present the XML as text to copy from their user interface. If you downloaded an XML file, don't open it in a browser for copying. Open it in a text editor like Notepad before copying the contents. Browsers may add text, spaces, and other formatting for readability, which renders the contents, particularly the certificate string, invalid in Agiloft CLM. Likewise, if you copied the contents from the IdP interface in a browser, paste the contents to a text editor first, then copy them from the text editor.

6. Paste the contents into the "SAML Metadata XML contents obtained from your IdP" text box.
7. Leave the remaining fields blank and click Finish. Agiloft CLM populates the rest of the fields based on the XML contents.

Agiloft CLM is now configured to use the new identity provider for SSO.

## > Macro (anchor)

Replace an OAuth Provider

Follow the steps below to replace an OAuth identity provider.

> 📝 To ensure users can log in with SSO after switching to the IdP, make sure each user’s SSO matching value in the new IdP is the same as the corresponding value in Agiloft CLM. Depending on the IdP configuration, the matching value might be the user’s email address, login, or another unique identifier.

1. First, if you haven’t done so already, register Agiloft CLM as an OAuth client in the new IdP. Refer to your provider’s documentation for instructions, or see the setup instructions in [OAuth 2.0 SSO](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/65341217).
  1. When you configure the IdP, you’ll need to the redirect URI from your existing OAuth profile. To get it, go to **Setup > Access > Configure OAuth 2.0 Profiles** and edit the OAuth profile. Then copy the URI in the Redirect URI field.
  2. When configuring the IdP, note the following client configuration details so you can enter them in Agiloft CLM:
    - The Client ID and Client Secret for the OAuth client
    - The OAuth 2.0 authorization endpoint for your IdP
    - The OAuth 2.0 token endpoint for your IdP
2. When the IdP setup is complete, go to **Setup > Access > Configure OAuth 2.0 Profiles** and edit your OAuth profile.
3. In the profile, change the OAuth 2.0 Identity(Auth) Provider Name to the name of the new provider.
4. In Client ID / Application ID / Consumer Key, replace the current value with the Client ID you copied when setting up the provider.
5. In Client / Consumer Secret, replace the value with the Client Secret from the new provider.
6. In Authentication URI, replace the value with the OAuth 2.0 authorization endpoint for the new provider.
7. In Token URI, replace the value with the OAuth 2.0 token endpoint for the new provider.
8. Click Finish.

Agiloft CLM is now configured to use the new identity provider for SSO.

#### Related articles

> Macro (contentbylabel)