You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/credentials-configure-common-providers.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,70 +1,70 @@
1
1
---
2
-
title: Configure credential providers - Azure API Management | Microsoft Docs
3
-
description: Learn how to configure common credential providers in Azure API Management's credential manager. Example providers are Microsoft Entra and generic OAuth 2.0.
2
+
title: Configure Credential Providers - Azure API Management | Microsoft Docs
3
+
description: Learn how to configure common credential providers in the Azure API Management credential manager. Providers include Microsoft Entra and generic OAuth.
4
4
services: api-management
5
5
author: dlepow
6
6
ms.service: azure-api-management
7
7
ms.topic: how-to
8
-
ms.date: 11/10/2023
8
+
ms.date: 10/03/2025
9
9
ms.author: danlep
10
10
ms.custom: sfi-image-nochange
11
+
# Customer intent: As an Azure service administrator, I want to learn how to configure common credential providers in the API Management credential manager.
11
12
---
12
13
13
14
# Configure common credential providers in credential manager
In this article, you learn about configuring identity providers for managed [connections](credentials-overview.md) in your API Management instance. Settings for the following common providers are shown:
18
+
In this article, you learn about configuring identity providers for managed [connections](credentials-overview.md) in your Azure API Management instance. Settings for the following common providers are shown:
18
19
19
-
* Microsoft Entra provider
20
-
* Generic OAuth 2.0 provider
20
+
* Microsoft Entra
21
+
* Generic OAuth 2
21
22
22
-
You configure a credential provider in your API Management instance's credential manager. For a step-by-step example of configuring a Microsoft Entra provider and connection, see:
23
-
24
-
*[Configure credential manager - Microsoft Graph API](authorizations-how-to-azure-ad.md)
23
+
You configure a credential provider in the credential manager in your API Management instance. For a step-by-step example of configuring a Microsoft Entra provider and connection, see [Configure credential manager - Microsoft Graph API](authorizations-how-to-azure-ad.md).
25
24
26
25
## Prerequisites
27
26
28
27
To configure any of the supported providers in API Management, first configure an OAuth 2.0 app in the identity provider that will be used to authorize API access. For configuration details, see the provider's developer documentation.
29
28
30
-
* If you're creating a credential provider that uses the authorization code grant type, configure a **Redirect URL** (sometimes called Authorization Callback URL or a similar name) in the app. For the value, enter `https://authorization-manager.consent.azure-apim.net/redirect/apim/<YOUR-APIM-SERVICENAME>`.
29
+
* If you're creating a credential provider that uses the authorization code grant type, configure a redirect URL (sometimes called an Authorization Callback URL or a similar name) in the app. For the value, enter `https://authorization-manager.consent.azure-apim.net/redirect/apim/<API-management-instance-name>`.
31
30
32
-
* Depending on your scenario, configure app settings such as scopes (API permissions).
31
+
* Depending on your scenario, configure app settings like scopes (API permissions).
33
32
34
33
* Minimally, retrieve the following app credentials that will be configured in API Management: the app's **client ID** and **client secret**.
35
34
36
-
* Depending on the provider and your scenario, you might need to retrieve other settings such as authorization endpoint URLs or scopes.
35
+
* Depending on the provider and your scenario, you might need to retrieve other settings, like authorization endpoint URLs or scopes.
37
36
38
37
* The provider's authorization endpoints must be reachable over the internet from your API Management instance. If your API Management instance is secured in a virtual network, configure network or firewall rules to allow access to the provider's endpoints.
39
38
40
39
## Microsoft Entra provider
41
40
42
-
API credential manager supports the Microsoft Entra identity provider, which is the identity service in Microsoft Azure that provides identity management and access control capabilities. It allows users to securely sign in using industry-standard protocols.
41
+
API Management credential manager supports the Microsoft Entra identity provider, which is the identity service in Azure that provides identity management and access control capabilities. It enables users to securely sign in via industry-standard protocols.
43
42
44
-
***Supported grant types**: authorization code, client credentials
43
+
**Supported grant types**: authorization code, client credentials
45
44
46
45
> [!NOTE]
47
-
> Currently, the Microsoft Entra credential provider supports only the Azure AD v1.0 endpoints.
46
+
> Currently, the Microsoft Entra credential provider supports only Azure Active Directory v1.0 endpoints.
You can use two generic providers for configuring connections:
56
+
You can use three generic providers for configuring connections:
58
57
59
58
* Generic OAuth 2.0
60
59
* Generic OAuth 2.0 with PKCE
60
+
* Generic OAuth 2.1 with PKCE with DCR
61
61
62
-
A generic provider allows you to use your own OAuth 2.0 identity provider based on your specific needs.
62
+
A generic provider enables you to use your own OAuth identity provider, based on your specific needs.
63
63
64
64
> [!NOTE]
65
-
> We recommend using the generic OAuth 2.0 with PKCE provider for improved security if your identity provider supports it. [Learn more](https://oauth.net/2/pkce/)
65
+
> We recommend using a PKCE provider for improved security if your identity provider supports it. For more information, see [Proof Key for Code Exchange](https://oauth.net/2/pkce/).
66
66
67
-
***Supported grant types**: authorization code, client credentials
67
+
**Supported grant types**: authorization code, client credentials (depends on provider)
68
68
69
69
### Generic credential provider settings
70
70
@@ -76,9 +76,9 @@ API Management supports several providers for popular SaaS offerings, including
76
76
77
77
:::image type="content" source="media/credentials-configure-common-providers/saas-providers.png" alt-text="Screenshot of identity providers listed in the portal.":::
78
78
79
-
**Supported grant types**: authorization code, client credentials (depends on provider)
79
+
**Supported grant types**: authorization code
80
80
81
-
Required settings for these providers differ from provider to provider but are similar to those for the [generic OAuth 2.0 providers](#generic-oauth-20-providers). Consult the developer documentation for each provider.
81
+
Required settings for these providers differ, depending on the provider, but are similar to those for the [generic OAuth providers](#generic-oauth-providers). Consult the developer documentation for each provider.
| Grant type | The OAuth 2.0 authorization grant type to use<br/><br/>Depending on your scenario, select either **Authorization code** or **Client credentials**. |Yes | Authorization code |
13
-
|**Authorization URL**|Authorization URL | No |`https://login.microsoftonline.com`|
14
-
| Client ID | The application (client) ID used to identify the Microsoft Entra app | Yes | N/A |
15
-
| Client secret | The client secret used for the Microsoft Entra app | Yes | N/A |
16
-
| Resource URL | The URL of the resource that requires authorization<br/><br/> Example: `https://graph.microsoft.com`| Yes | N/A |
17
-
| Tenant ID | The tenant ID of your Microsoft Entra app | No | common |
18
-
| Scopes | One or more API permissions for your Microsoft Entra app, separated by the " " character <br/><br/>Example: `ChannelMessage.Read.All User.Read`| No | API permissions set in Microsoft Entra app |
10
+
|**Credential provider name**|The name of the credential provider resource in API Management.|Yes | N/A |
11
+
|**Identity provider**| Select **Azure Active Directory v1**.|Yes | N/A |
12
+
|**Grant type**| The OAuth 2.0 authorization grant type to use.<br/><br/>Depending on your scenario, select either **Authorization code** or **Client credentials**. |Yes |**Authorization code**|
13
+
|**Authorization URL**|The authorization URL.| No |`https://login.microsoftonline.com`|
14
+
|**Client ID**| The application (client) ID used to identify the Microsoft Entra app.| Yes | N/A |
15
+
|**Client secret**| The client secret used for the Microsoft Entra app.| Yes | N/A |
16
+
|**Resource URL**| The URL of the resource that requires authorization.<br/><br/> Example: `https://graph.microsoft.com`| Yes | N/A |
17
+
|**Tenant ID**| The tenant ID of your Microsoft Entra app.| No |**common**|
18
+
|**Scopes**| One or more API permissions for your Microsoft Entra app, separated by spaces. <br/><br/>Example: `ChannelMessage.Read.All User.Read`| No | API permissions set in the Microsoft Entra app |
Copy file name to clipboardExpand all lines: includes/api-management-authorization-generic-provider.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,18 @@
2
2
author: dlepow
3
3
ms.service: azure-api-management
4
4
ms.topic: include
5
-
ms.date: 02/02/2023
5
+
ms.date: 10/03/2025
6
6
ms.author: danlep
7
7
---
8
8
| Property | Description | Required | Default |
9
9
|---|---|---|---|
10
-
| Provider name | Name of credential provider resource in API Management |Yes | N/A |
11
-
| Identity provider | Select **Generic Oauth 2** or **Generic Oauth 2 with PKCE**. |Yes | N/A |
12
-
| Grant type | The OAuth 2.0 authorization grant type to use <br/><br/>Depending on your scenario and your identity provider, select either **Authorization code** or **Client credentials**. |Yes | Authorization code |
13
-
| Authorization URL | The authorization endpoint URL | No | UNUSED |
14
-
| Client ID | The ID used to identify an app to the identity provider's authorization server | Yes | N/A |
15
-
| Client secret | The secret used by the app to authenticate with the identity provider's authorization server | Yes | N/A |
16
-
| Refresh URL | The URL that your app makes a request to in order to exchange a refresh token for a renewed access token | No | UNUSED |
17
-
| Token URL | The URL on the identity provider's authorization server that is used to programmatically request tokens | Yes | N/A |
18
-
| Scopes | One or more specific actions the app is allowed to do or information that it can request on a user's behalf from an API, separated by the " " character<br/><br/> Example: `user web api openid`| No | N/A |
10
+
|**Credential provider name**| The name of credential provider resource in API Management. |Yes | N/A |
11
+
|**Identity provider**| Select **OAuth 2.0**, **OAuth 2.0 with PKCE**, or **OAuth 2.1 with PKCE with DCR**. |Yes | N/A |
12
+
|**Grant type**| The OAuth 2.0 authorization grant type to use. <br/><br/>Depending on your scenario and your identity provider, select either **Authorization code** or **Client credentials**. |Yes |**Authorization code**|
13
+
|**Authorization URL**| The authorization endpoint URL. | Yes, for PKCE | UNUSED for OAuth 2.0|
14
+
|**Client ID**| The ID used to identify an app to the identity provider's authorization server. | Yes | N/A |
15
+
|**Client secret**| The secret used by the app to authenticate with the identity provider's authorization server. | Yes | N/A |
16
+
|**Refresh URL**| The URL that your app makes a request to in order to exchange a refresh token for a renewed access token. | Yes, for PKCE | UNUSED for OAuth 2.0 |
17
+
|**Server URL**|The base server URL. |Yes, for OAuth 2.1 with PKCE with DCR|N/A|
18
+
|**Token URL**| The URL on the identity provider's authorization server that's used to programmatically request tokens. | Yes | N/A |
19
+
|**Scopes**| One or more specific actions the app is allowed to do or information that it can request on a user's behalf from an API, separated by spaces.<br/><br/> Example: `user web api openid`| No | N/A |
0 commit comments