Configure Azure Active Directory (Azure AD) as an External Identity Provider (IdP)¶
In organizations leveraging Microsoft Azure Active Directory (Azure AD) for identity and access management (IAM), integrating it with Choreo offers powerful API access control. This control hinges on the use of API scopes. That is, it enables the restriction of access to a designated group of users. This document guide you step-by-step to configure Azure AD as your external IdP.
Prerequisites¶
Before you try out this guide, be sure you have the following:
- An Azure Active Directory account: If you don’t already have one, setup an Azure Active Directory account at https://azure.microsoft.com/en-gb/.
- Administrator rights to your Choreo organization: You need this to configure the Azure AD account in your organization.
Add Azure Active Directory as an external IdP in Choreo¶
Follow the steps below to add Azure AD as an IdP in Choreo:
- Sign in to the Choreo Console at https://console.choreo.dev/.
- In the left navigation menu, click Settings.
- In the header, click the Organization list. This will open the organization level settings page.
- On the Application Security tab, click Identity Providers and then click + Identity Provider.
- Select Microsoft Entra ID (Azure AD) as the Identity Provider.
- Provide a name and a description for the IdP.
-
To obtain the
Well-Known URL
of your Azure AD instance, on your Azure account, under Azure Active Directory go to App registrations, and then Endpoints. Copy the URI underOpenID Connect metadata document
.Info
- In azure, there are two versions of access tokens available. By default, the IDP applications you create use the v1 access token. Therefore, if you intend to use the v1 access token, when providing the
Well-Known URL
, omit the v2.0 path segment from the URL. Learn more For example, converthttps://login.microsoftonline.com/<tenant-id>/v2.0/.well-known/openid-configuration
->https://login.microsoftonline.com/<tenant-id>/.well-known/openid-configuration
- If you intend to work with v2.0, then the IDP application's manifest should be changed as explained in the access tokendocumentation.
- In azure, there are two versions of access tokens available. By default, the IDP applications you create use the v1 access token. Therefore, if you intend to use the v1 access token, when providing the
-
Leave the Apply to all environments checkbox selected. However, if you want to restrict the use of the external IdP to a certain environment, you can select them from the Environments list.
- Review the endpoints and click Next.