Configuring Active Directory Federation Services as Identity Provider for Historical Reporting

Last Updated : Jun 06, 2022 |
Prolog information
You can configure a relying party trust for SAML authentication with Historical Reporting. The terms used here are specific to Active Directory Federation Services (ADFS) on Windows Server 2016 as an Identity Provider (IDP).
Before you begin
You must have the unique identifier of the web application to be recognized by the IDP. For example, AnalyticsWebHome.
URL from which IDP sends and receives SAML requests and responses. For example, https://cluster.fqdn/AvayaAnalytics.
  1. Log in to Active Directory Federation Services (ADFS) server and open the ADFS Management UI.
  2. Click Add Relying Party Trust to add a new relying party trust.
  3. On the Welcome page, select the Claims aware option and click Start.
  4. In the Select Data Source window, select Enter data about the relying party manually option and click Next.
  5. In the Specify Display Name window, add a name for this relying party trust and click Next.
  6. In the Configure Certificate window, leave blank if not applicable and click Next.
  7. In the Configure URL window, click Enable support for the SAML 2.0 WedSSO protocol option, and then add the URL from which IDP sends and receives SAML requests and responses. Click Next.
  8. In the Configure URL window, add the URL from which IDP sends and receives SAML requests and responses. Click Next.
    ADDITIONAL INFORMATION:
    For example, https://cluster.fqdn/AvayaAnalytics and append on /saml/SSO
  9. In the Configure Identifiers window, add the unique identifier of the web application to be recognized by the IDP and click Next.
    ADDITIONAL INFORMATION:
    For example, AnalyticsWebHome.
  10. In the Choose Access Control Policy, select the required access control policy and click Next.
  11. In the Ready to Add Trust window, confirm your settings and click Next.
  12. In the Finish window, check the configure claims issuance policy for this application and click Close.
  13. In Edit Claim Issuance Policy for your relying party trust, click Add Rule.
  14. In the Select Rule Template window, select Send LDAP Attributes as Claims from the dropdown and click Next.
  15. In the Configure Rule window, add the rule name. For example, Name ID.
    ADDITIONAL INFORMATION:
    Identify the Attribute store as Active Directory from the drop down menu.
  16. To map the SAM-Account-Name to Name ID of the user from the LDAP Attribute, select or type SAM-Account-Name, and for the Outgoing Claim type, select Name ID.
  17. To map the Distinguished name of the user from the LDAP Attribute, select or type distinguishedname, and for the Outgoing Claim type, select or type DistinguishedName.
  18. To map the E-Mail Address of the user from the LDAP Attribute, select or type E-Mail-Addresses, and for the Outgoing Claim type, select or type EMail.
  19. To map the DisplayName of the user from the LDAP Attribute, select or type Display-Name, and for the Outgoing Claim type, select or type DisplayName.
  20. To map the Groups name of the user from the LDAP Attribute, select or type Token-Groups – Unqualified Names, and for the Outgoing Claim type, select or type Groups.
    ADDITIONAL INFORMATION:
    Note:
    The following strings must match with attributes as provided when configuring SAML using post-install steps:
    • DistinguishedName must match the User display name attribute
    • EMail must match the User email address attribute
    • DisplayName must match the User distinguished name attribute
    • Groups must match the User group attribute
  21. To add a SAML logout endpoint, do the following:
    1. Select Properties to edit the relying party trust.
    2. Go to the Endpoints tab.
    3. Select Add SAML,
    4. On the Add Endpoint window, select SAML logout from dropdown list.
    5. For Binding select POST from dropdown list.
  22. For the trusted URL, add the URL from which IDP sends and receives SAML requests and responses. Click Ok.
    ADDITIONAL INFORMATION:
    https://cluster.fqdn/AvayaAnalytics and append on /saml/SingleLogout
  23. To export the IDP metadata.xml, enter the URL of the ADFS server.
    ADDITIONAL INFORMATION:
    https://adfsServer.domain.com/FederationMetadata/2007-06/FederationMetadata.xml
    The Federation Metadata.xml file downloads to your default downloads location.
  24. Rename the downloaded IDP metadata file as IDPMetadata.xml and copy it using WinSCP file to the CCM.