APPLIES TO: Developer | Basic v2 | Standard | Standard v2 | Premium | Premium v2
In this article, you'll learn how to:
For an overview of options to secure the developer portal, see Secure access to the API Management developer portal.
Important
Complete the Create an Azure API Management instance quickstart.
Import and publish an API in the Azure API Management instance.
If you created your instance in a v2 tier, enable the developer portal. For more information, see Tutorial: Access and customize the developer portal.
Use the Bash environment in Azure Cloud Shell. For more information, see Get started with Azure Cloud Shell.
If you prefer to run CLI reference commands locally, install the Azure CLI. If you're running on Windows or macOS, consider running Azure CLI in a Docker container. For more information, see How to run the Azure CLI in a Docker container.
If you're using a local installation, sign in to the Azure CLI by using the az login command. To finish the authentication process, follow the steps displayed in your terminal. For other sign-in options, see Authenticate to Azure using Azure CLI.
When you're prompted, install the Azure CLI extension on first use. For more information about extensions, see Use and manage extensions with the Azure CLI.
Run az version to find the version and dependent libraries that are installed. To upgrade to the latest version, run az upgrade.
In the Azure portal, search for and select API Management services:
On the API Management services page, select your API Management instance:
To simplify the configuration, API Management can automatically enable a Microsoft Entra application and identity provider for users of the developer portal. Alternatively, you can manually enable the Microsoft Entra application and identity provider.
Automatically enable Microsoft Entra application and identity providerIn the left menu of your API Management instance, under Developer portal, select Portal overview.
On the Portal overview page, scroll down to Enable user sign-in with Microsoft Entra ID.
Select Enable Microsoft Entra ID.
On the Enable Microsoft Entra ID page, select Enable Microsoft Entra ID.
Select Close.
After the Microsoft Entra provider is enabled:
In the left menu of your API Management instance, under Developer portal, select Identities.
Select +Add from the top to open the Add identity provider pane to the right.
Under Type, select Microsoft Entra ID from the drop-down menu. Once selected, you'll be able to enter other necessary information.
Save the Redirect URL for later.
In your browser, open the Azure portal in a new tab.
Navigate to App registrations to register an app in Active Directory.
Select New registration. On the Register an application page, set the values as follows:
After you've registered the application, copy the Application (client) ID from the Overview page.
Switch to the browser tab with your API Management instance.
In the Add identity provider window, paste the Application (client) ID value into the Client ID box.
Switch to the browser tab with the App registration.
Select the appropriate app registration.
Under the Manage section of the side menu, select Certificates & secrets.
From the Certificates & secrets page, select the New client secret button under Client secrets.
Copy the client Secret value before leaving the page. You will need it later.
Under Manage in the side menu, select Token configuration > + Add optional claim.
Switch to the browser tab with your API Management instance.
Paste the secret into the Client secret field in the Add identity provider pane.
Important
Update the Client secret before the key expires.
In Signin tenant, specify a tenant name or ID to use for sign-in to Microsoft Entra. If no value is specified, the Common endpoint is used.
In Allowed tenants, add specific Microsoft Entra tenant names or IDs for sign-in to Microsoft Entra.
After you specify the desired configuration, select Add.
Republish the developer portal for the Microsoft Entra configuration to take effect. In the left menu, under Developer portal, select Portal overview > Publish.
After the Microsoft Entra provider is enabled:
If you previously configured a Microsoft Entra app for user sign-in using the ADAL, you can use the portal to migrate the app to MSAL and update the identity provider in API Management.
Update Microsoft Entra app for MSAL compatibilityFor steps, see Switch redirect URIs to the single-page application type.
Update identity provider configurationNow that you've enabled access for users in a Microsoft Entra tenant, you can:
User.Read.All
application permission â so API Management can read the userâs group membership to perform group synchronization at the time the user logs in.Group.Read.All
application permission â so API Management can read the Microsoft Entra groups when an administrator tries to add the group to API Management using the Groups blade in the portal.Now you can add external Microsoft Entra groups from the Groups tab of your API Management instance.
Under Developer portal in the side menu, select Groups.
Select the Add Microsoft Entra group button.
Select the Tenant from the drop-down.
Search for and select the group that you want to add.
Press the Select button.
Once you add an external Microsoft Entra group, you can review and configure its properties:
Users from the configured Microsoft Entra instance can now:
Groups configured in Microsoft Entra must synchronize with API Management so that you can add them to your instance. If the groups don't synchronize automatically, do one of the following to synchronize group information manually:
In the developer portal, you can sign in with Microsoft Entra ID using the Sign-in button: OAuth widget included on the sign-in page of the default developer portal content.
Although a new account will automatically be created when a new user signs in with Microsoft Entra ID, consider adding the same widget to the sign-up page. The Sign-up form: OAuth widget represents a form used for signing up with OAuth.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4