Skip to main content Skip to complementary content
Qlik Resources

OIDC configuration with AD FS

OpenID Connect (OIDC) is an authentication layer on top of OAuth 2.0, an authorization framework. OIDC enables single sign-on (SSO) to reduce the number of times a user has to log on to access websites and applications. OIDC can be configured for authentication with third-party products.

Configuring AD FS

This topic describes how you configure AD FS, but not how to install AD FS. AD FS will be the identity provider in your configuration, and before you can begin configuring, you need access to AD FS.

Information noteBecause this configuration involves a third-party product, we cannot guarantee that the configuration is exactly as described here. Changes may occur in the third-party product, without our knowledge.

Do the following:

  1. In AD FS, open the Server Manager.

  2. In the menu to the right, select Tools > AD FS Management.

  3. In the AD FS management pane, select Application Groups > Actions > Add an Application Group.

  4. Select Server Application. Enter a name and description. Click Next.

  5. Under Server Application, there is a client ID. Note it down.

  6. Enter the Redirect URI: https://<QSEhostname>/<VirtualProxyPrefix>/oidcauthn and click the Add URI button. Click Next.

  7. Select Generate a shared secret. A secret key is generated. Note it down.

    A summary of your settings is displayed. Click Next and complete the steps for adding the application group.

  8. Open the created application group.

    The Properties window appears.

  9. Click Add application.

    A new window appears: Add a new application to <app group name>.

  10. Select Web API template. Click Next.

  11. Optionally, edit the Web API name.

  12. Under Identifier, add the client ID that you noted down when creating the server application in this application group. Click Next.

  13. Under Apply Access Control Policy, select Permit everyone. Click Next.

  14. Under Configure Application Permissions > Client application, the server application is selected. Keep this unchanged. Under Permitted scopes, select allatclaims, email, openid, and profile. Click Next.

  15. A summary of your settings is shown. Click Next to complete the steps for adding the Web API.

  16. Open Web API > Issuance Transform Rules.

  17. Click Add Rule. Enter a name for the rule, select Active Directory for Attribute store and then add “E-Mail Addresses” – “E-Mail Address” and "Token-Groups - Unqualified Names" - "Group" mapping. Save your changes.

  18. Navigate to Relying Party Trusts in the ADFS Management tool.

  19. Make sure you have the following relying party trust. Identifier should be https://<ADFShostname>/adfs/services/trust.

  20. If the relying party trust is not available, you need to add a new. Follow the steps described in https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/create-a-relying-party-trust#to-create-a-claims-aware-relying-party-trust-manually, but skip the steps Configure certificate and Configure URL.

  21. Make sure you add the email address for users who will be using Qlik Sense Enterprise sites through AD FS authentication.

    1. Open Active Directory Users and Computers on the AD server.

    2. Navigate to the Users folder, right-click the user and select Properties.

    3. Under General, enter the user’s email address in the E-mail field.

    4. Click OK to save the changes.

Creating and configuring the virtual proxy

Do the following:

  1. In the Qlik Management Console (QMC), open Virtual proxies.

  2. Click Create new Create new.

  3. In Properties, to the right, ensure that the sections Identification, Authentication, Load balancing, and Advanced are selected.

  4. Under Identification, enter adfs for Description and Prefix.

  5. For Session cookie header name, add -adfs at the end of the existing name so that it reads X-Qlik-Session-adfs.

  6. For Authentication method, select OIDC.

  7. Enter the “OpenID Configuration” URL in the OpenID Connect metadata URI field. The URL should be in the following format: https://<ADFShostname>/adfs/.well-known/openid-configuration.

  8. Enter the noted Client ID and Client secret in the corresponding fields.

  9. For Realm, enter adfs. Users added in the repository through OIDC authentication will have user directory name set to “adfs”.

    Information noteIf the subject attribute value format is domainname\username, realm is optional. If not, realm is mandatory.
    The attributes sub, name, and email are mandatory.

  10. In the name field, change the value to unique_name.

  11. In the groups field, change the value to group.

  12. In the client_id field, change the value to appid.

  13. In the scope field, enter openid allatclaims profile email.

  14. Under Load balancing nodes, click Add new server node.

  15. Select the engine nodes this virtual proxy will load balance connections to.

  16. Under Advanced, in the Host allow list section, click Add new value.

  17. Add the host name of the AD FS server.

  18. Click Apply and then OK to restart the services.

  19. In the Associated items menu to the right, select Proxies.

  20. Click Link and link the virtual proxy to the proxy or proxies that will use this configuration.

    The proxy service is restarted.

Verify that the claims and scopes that you have configured in the IdP server are returned in claims_supported and scopes_supported tags when you select the OpenID Connect Metadata URI, https://{IdP_hostname}/.well-known/openid-configuration.

This completes the AD FS configuration.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here