> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Active Directory as an OAuth 2.0 External Identity Provider

> Configure Active Directory Federation Services (AD FS) as an OAuth 2.0 External Identity Provider for your ABBYY Vantage tenant.

## Prerequisites

* The Active Directory Federation Service (ADFS) needs to be installed.
* A user group must be created in Active Directory. This group is used to manage the list of users permitted to access Vantage.
* Create a Redirect URI to receive the authentication responses. The URI is: \
  `https://<your-vantage-url>/auth2/signin-oidc`

## Setup

To set up Active Directory via the AD FS management console, follow these steps:

<Steps>
  <Step title="Open the management console">
    Open the AD FS management console.
  </Step>

  <Step title="Add a new application group">
    Add a new application group and select the **Web browser accessing a web application** template.

    <Frame>
      <img src="https://mintcdn.com/abbyy/jZX7kaKQgdxaDiIT/images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_1.png?fit=max&auto=format&n=jZX7kaKQgdxaDiIT&q=85&s=9c4fee4780e2ed659d58c4b3b2a77c70" alt="AD FS Add Application Group wizard with Web browser accessing a web application template selected" style={{ width:"68%" }} width="716" height="582" data-path="images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_1.png" />
    </Frame>
  </Step>

  <Step title="Configure the Native Application">
    In the **Native Application** tab, enter your Redirect URI and save the generated Client Identifier — you'll need it later. You can also view it again in the application group properties.

    <Frame>
      <img src="https://mintcdn.com/abbyy/jZX7kaKQgdxaDiIT/images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_2.png?fit=max&auto=format&n=jZX7kaKQgdxaDiIT&q=85&s=9a5a8f7578b4abf728c10cbb7c8e51c3" alt="AD FS Native Application tab with Redirect URI and Client Identifier fields" style={{ width:"68%" }} width="716" height="582" data-path="images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_2.png" />
    </Frame>
  </Step>

  <Step title="Apply an Access Control Policy">
    In the **Apply Access Control Policy** tab, select a user group to grant access to Vantage. Leave the default value of **Allow everyone** if you don't want to restrict access yet.

    <Frame>
      <img src="https://mintcdn.com/abbyy/jZX7kaKQgdxaDiIT/images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_3.png?fit=max&auto=format&n=jZX7kaKQgdxaDiIT&q=85&s=d5accd0c43f3a1e4c579a11f2a8b3dd2" alt="AD FS Apply Access Control Policy tab with user group selection for Vantage access" style={{ width:"77%" }} width="716" height="582" data-path="images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_3.png" />
    </Frame>
  </Step>

  <Step title="Skip the Summary and Complete tabs">
    The **Summary** and **Complete** tabs aren't required to set up Active Directory. Navigate through them and click **Close**.
  </Step>

  <Step title="Save the Application ID">
    Open the properties of the application group you created. You can also manage Redirect URI and Client ID via **Server application Properties**. For advanced settings, use **Web application Properties** — this is also where you'll find the **Application ID**. Save it, since it's required later in the setup.
  </Step>

  <Step title="Add a Transform Claim Rule">
    In the **Add Transform Claim Rule** dialog, add a claim rule that ensures the email address and name are included in the token.

    <Frame>
      <img src="https://mintcdn.com/abbyy/jZX7kaKQgdxaDiIT/images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_4.png?fit=max&auto=format&n=jZX7kaKQgdxaDiIT&q=85&s=bf8b71db7ac51b7f5eee4412097376f1" alt="AD FS Add Transform Claim Rule dialog for emitting email and name claims in the OAuth 2.0 token" style={{ width:"78%" }} width="718" height="583" data-path="images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_4.png" />
    </Frame>
  </Step>

  <Step title="Configure the Claim Rule">
    In the **Configure Claim Rule** tab, select **Active Directory** in **Attribute Store**.

    <Frame>
      <img src="https://mintcdn.com/abbyy/jZX7kaKQgdxaDiIT/images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_5.png?fit=max&auto=format&n=jZX7kaKQgdxaDiIT&q=85&s=5b13bfc1fb91fc3a24ef0da545e81dc4" alt="AD FS Configure Claim Rule tab with Active Directory selected as the attribute store" style={{ width:"72%" }} width="716" height="582" data-path="images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_5.png" />
    </Frame>
  </Step>

  <Step title="Set Client Permissions">
    In the **Web application Properties** dialog, open the **Client Permissions** tab, select the **openid** and **profile** scopes, then click **Apply**.

    <Frame>
      <img src="https://mintcdn.com/abbyy/jZX7kaKQgdxaDiIT/images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_6.png?fit=max&auto=format&n=jZX7kaKQgdxaDiIT&q=85&s=e2f82f8f2a60733b937b051e75862d2a" alt="AD FS Web Application Properties Client Permissions tab with openid and profile scopes selected" style={{ width:"69%" }} width="486" height="543" data-path="images/vantage/tenant-admin/sysadmin_identityprovider_activedirectory_6.png" />
    </Frame>
  </Step>
</Steps>

## Next steps

Once AD FS is configured, connect it to your Vantage tenant. You'll need:

* The **Application (Client) ID** (from step 6 above).
* The AD FS URL in the format `https://<full-computer-name>/adfs`. The **Full computer name** is in the machine's system settings — for example, `https://adfs.platform.local/adfs`.

For the Vantage-side setup, see [Setting up an External Identity Provider for a tenant](/vantage/documentation/tenant-admin/tenant-management/configuring-tenant).

## Related topics

<CardGroup cols={2}>
  <Card title="Configuring an OAuth 2.0 External Identity Provider" icon="key" href="/vantage/documentation/tenant-admin/tenant-management/oauth-2-0">
    Overview of OAuth 2.0 setup for AD FS or Azure AD
  </Card>

  <Card title="Azure Active Directory as an OAuth 2.0 External Identity Provider" icon="cloud" href="/vantage/documentation/tenant-admin/tenant-management/oauth-2-0-azure-active-directory">
    Configure Azure AD instead of on-premises AD FS
  </Card>

  <Card title="Setting up an External Identity Provider for a tenant" icon="sliders" href="/vantage/documentation/tenant-admin/tenant-management/configuring-tenant">
    Connect AD FS to your Vantage tenant
  </Card>

  <Card title="Testing external authentication" icon="vial" href="/vantage/documentation/tenant-admin/tenant-management/testing-external-auth">
    Verify the External Identity Provider before users sign in
  </Card>
</CardGroup>
