Skip to main content

Prerequisites

  • Ensure that you have a Vantage tenant identifier before configuring identities. To get a tenant identifier, by click Configuration in ABBYY Vantage. The identifier is on the General tab.
  • Create a Redirect URI to receive the authentication responses. The URI is:
    https://<your-vantage-url>/auth2/Saml2/Acs

Setup

The setup process consists of the following steps:

Adding a Claim Description

  1. Open the management console.
  2. Select Service > Claim Descriptions. Click Add Claim Description.
  3. Fill in the required fields:
    • Specify a display name: such as Persistent Identifier.
    • Specify a claim type: urn:oasis:names:tc:SAML:2.0:nameid-format:persistent.
    • Select Publish this claim description in federation metadata as a claim type that this federation service can accept.
    • Select Publish this claim description in federation metadata as a claim type that this federation service can send.
Add Claim Description
  1. Click OK.
Now, you can control how user attributes are mapped between different systems.

Configuring a Relying Party Trust

To create an ADFS relying party trust, follow these steps:
  1. In the console tree, under AD FS, select Trust Relationships > Relying Party Trusts > Add Relying Party Trust.
  2. On the Welcome page, choose Claims aware and select Start.
  3. On the Select Data Source page, select Enter data about the relying party manually, and then select Next.
  4. On the Specify Display Name page, enter any name in Display Name, and then select Next.
  5. On the Choose Profile page, select the ADFS 2.0 profile, and then click Next.
  6. On the Configure Certificate page, click Next.
  7. On the Configure URL page, select the Enable support for the SAML 2.0 WebSSO protocol. Under Relying party SAML 2.0 SSO service URL, enter https://<your-vantage-url>/auth2/Saml2/Acs, and then click Next.
  8. To configure identities, follow these steps:
    • Under Relying party trust identifier, enter api://platform.abbyy.cloud/tenantId, where tenantId is the tenant identifier in GUID format without hyphens (for example, 117489fc1aea41658369d4d18d6557ga), and then click Add.
    • In the window that opens, select the Expose an API tab and replace the Application ID URI with api://platform.abbyy.cloud/tenantId, where tenantId is the tenant identifier in GUID format without hyphens (for example, 117489fc1aea41658369d4d18d6557ga), click Add, and then click Next.
  9. If you want to provide access to Vantage to all users, select Permit all users to access this relying party in the Choose Issuance Authorization Rules window. Alternatively, select Permit specific group and specify the desired group if you want to provide access only to that specific group. Click Next.
  10. On the Ready to Add Trust page, review the settings. Click Next, and then click Close.
A trust relationship between an Identity Provider and ABBYY Vantage is established.

Adding Rules to Transform an Incoming Claim

To apply rules to transform an incoming claim, follow these steps:
  1. Click Relying Party Trusts.
  2. Right-click the selected trust, and then click Edit Claim Issuance Policy.
  3. In the Edit Claim Issuance Policy for <name> window that opens, click Add Rule.
Edit Claim Issuance Policy
  1. Select the Transform an Incoming Claim claim rule template, and then click Next.
Transform Incoming Claim
  1. Select the Configure Claim Rule step, and then specify the following:
    • In Claim rule name, specify TransformWindows account name.
    • In Incoming claim type, select Windows account name.
    • In Outgoing claim type, select Name ID.
    • In Outgoing name ID format, select Persistent Identifier.
    • Select Pass through all claim values.
Configure Claim Rule
  1. Click Finish.
  2. Add another rule to ensure that e-mail and name claims are included in the issued token. On the Select Rule Template page, select Send LDAP Attributes as Claims under Claim rule template, and then click Next.
Send LDAP Attributes
  1. On the Configure Claim Rule page, select the Active Directory attribute store under Claim rule name, and then click Finish.
Active Directory Attribute Store
  1. The added rules are displayed in the Edit Claim Rules dialog box.
Edit Claim Rules Dialog

Next Steps

Set up authentication via a SAML 2.0 External Identity Provider for your tenant in Vantage, which requires the federation metadata document URL in the following format: https://<adfs_server_address>/federationmetadata/2007-06/federationmetadata.xml. For example, https://adfs.platform.local/federationmetadata/2007-06/federationmetadata.xml. For more information, see Setting up an External Identity Provider for a tenant.