Configuring Azure Active Directory as an OIDC Identity Provider

Note: Pivotal Platform is now part of VMware Tanzu. In v1.12 and later, Pivotal Single Sign‑On is named Single Sign‑On for VMware Tanzu.

This topic describes how to integrate Azure Active Directory (Azure AD) as an identity provider for a Single Sign‑On for VMware Tanzu plan, by configuring OpenID Connect (OIDC) in both Single Sign‑On and Azure AD.

Overview

Azure Active Directory (Azure AD) is Microsoft’s multi-tenant cloud-based directory and identity management service. It is one of several identity providers you can use in a Single Sign‑On service plan.

To set up the integration, follow the procedures below:

  1. Set up a Relying Party in Azure AD
  2. Set up the OIDC Identity Provider in Single Sign‑On

Prerequisites

Before you can set up a relying party in Azure AD, you must meet the prerequisites listed in Azure Active Directory OIDC Integration Guide Overview.

Set Up a Relying Party in Azure AD

Follow the procedures below to set up a relying party in Azure AD.

Register a New App

To register a new app:

  1. Log in to your Azure account and navigate to Azure Active Directory > App registrations.

    The information depicted in this screenshot is described in the step above.

  2. Select + to create a New application registration. A configuration pane appears.

    The information depicted in this screenshot is described in the step above.

  3. Enter a name of your choice in the Name field.

  4. Select Web App/API from the Application type dropdown.

  5. Enter the sign-on URL in the Sign-on URL field. This can be the URL for the login portal, if you want. This URL has the following pattern:

    https://AUTH-DOMAIN.login.SYSTEM-DOMAIN
    

    For example:

    The information depicted in this screenshot is described in the steps above.

Generate a Relying Party OAuth Client Secret

To create a client secret:

  1. Use the search bar to find your app registration, and click on its listing in the search results.

    The information depicted in this screenshot is described in the step above.

  2. Record the Application ID displayed on the screen. This is the Relying Party OAuth Client ID.

    The information depicted in this screenshot is described in the step above.

  3. Open the Keys tab.

    The information depicted in this screenshot is described in the step above.

  4. Enter a name for the key in the DESCRIPTION field.

  5. Select a duration appropriate for your security requirements in the EXPIRES field.

    The information depicted in this screenshot is described in the steps above.

  6. Click Save to generate your key value. This value is the Relying Party OAuth Client Secret. Record this value for later use.

    The information depicted in this screenshot is described in the step above.

Configure Reply and Endpoint URLs

To create reply and endpoint URLs:

  1. Under Reply URLs, configure and save the URL using the following pattern:

    https://AUTH-DOMAIN.login.SYSTEM-DOMAIN/login/callback/ORIGIN-KEY
    

    Where:

    • AUTH-DOMAIN is the Auth Domain you entered in Create or Edit Service Plans.
    • ORIGIN-KEY is based on the Identity Provider Name you set in the SSO Operator Dashboard in Set Up OIDC Identity Provider in SSO as shown below. Do not use spaces or uppercase letters in this value. You might need to change this later.

    The information depicted in this screenshot is described in the step above.

  2. Identify your Azure Tenant Name. One location you can use to help you identify this is the App ID URI which uses the form https://TENANT-NAME/APPLICATION-ID.

    For example, in the App ID URI https://tenant.onmicrosoft.com/cj8472j2-d3d2-44b1-a2zf-ro5cd03f9584, the Azure Tenant Name is tenant.onmicrosoft.com.

    The information depicted in this screenshot is described in the step above.

  3. Construct the URL for the OpenID Connect metadata endpoint by replacing TENANT-NAME with your Azure Tenant Name in the following string: https://login.microsoftonline.com/TENANT-NAME/.well-known/openid-configuration. Example: https://login.microsoftonline.com/tenant.onmicrosoft.com/.well-known/openid-configuration

    Record these values for the next step, configuring your OpenID Connect identity provider in Single Sign‑On.

    Screenshot of OpenID Connect metadata

Set Up the OIDC Identity Provider in Single Sign‑On

Follow the steps below to set up an OIDC provider for Single Sign‑On.

  1. Follow steps 1–6 in Add an OIDC Provider.

  2. Clear the Enable Discovery checkbox and enter the following information from the OpenID Connect metadata endpoint you constructed in the final step of the previous section.

    For… Do the following…
    Authorization Endpoint URL Enter the authorization_endpoint value from the metadata endpoint.
    Token Endpoint URL Enter the token_endpoint value from the metadata endpoint.
    Token Key Enter the jwks_uri value from the metadata endpoint.
    Issuer Enter the issuer value from the metadata endpoint.
    User Info Endpoint URL Enter the userinfo_endpoint value from the metadata endpoint.
    Response Type Select code from the dropdown.
    Relying Party OAuth Client ID Enter the Application ID you recorded in step 5 of Configuring Azure Active Directory as an OIDC Identity Provider.
    Relying Party OAuth Client Secret Enter the Client Secret you recorded in step 8 of Configuring Azure Active Directory as an OIDC Identity Provider.

  3. Select openid as a scope. You can select additional scopes.

  4. Under Advanced Settings > Attribute Mappings (optional) > User Attributes, select user_name as the User Schema Attribute and enter unique_name as the Attribute Name. This enables Single Sign‑On to identify the authenticated user.

  5. (Optional) Configure additional attribute mappings.

  6. Click Create Identity Provider to save your settings.

  7. (Optional) Enable identity provider discovery for the service plan.