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-center/authorize-api-access.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn how to configure access to APIs in the Azure API Center inven
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 04/30/2025
7
+
ms.date: 06/02/2025
8
8
ms.author: danlep
9
9
ms.custom:
10
10
# Customer intent: As an API program manager, I want to store API authorization information in my API center and enable authorized users to test APIs in the API Center portal.
@@ -57,12 +57,12 @@ To manage the API key securely, store it in Azure Key Vault, and access the key
|**Description**|Optional description for the authorization. |
60
+
|**Title**|Enter a name for the authorization. |
61
+
|**Description**|Optionally, enter a description for the authorization. |
62
62
|**Security scheme**| Select **API Key**. |
63
-
|**API key location**|How the key is presented in API requests. Available values are **Header** (request header) and **Query** (query parameter). |
64
-
|**API key parameter name**|Name of the HTTP header or query parameter that contains the API key. Example: `x-api-key`|
65
-
|**API key Key Vault secret reference**|Secret identifier of the API key in Azure Key Vault. Example: `https://<key-vault-name>.vault.azure.net/secrets/<secret-name>/<version>`|
63
+
|**API key location**|Select how the key is presented in API requests. Available values are **Header** (request header) and **Query** (query parameter). |
64
+
|**API key parameter name**|Enter the name of the HTTP header or query parameter that contains the API key. Example: `x-api-key`|
65
+
|**API key Key Vault secret reference**|Click **Select** and select the subscription, key vault, and secret that you stored. Example: `https://<key-vault-name>.vault.azure.net/secrets/<secret-name>`|
66
66
67
67
1. Select **Create**.
68
68
@@ -122,16 +122,16 @@ To manage the secret securely, store it in Azure Key Vault, and access the key v
|**Description**|Optional description for the authorization. |
125
+
|**Title**|Enter a name for the authorization. |
126
+
|**Description**|Optionally, enter a description for the authorization. |
127
127
|**Security scheme**| Select **OAuth2**. |
128
-
|**Client ID**|Client ID (GUID) of the app that you created in your identity provider. |
129
-
|**Client secret**|Secret identifier of the client secret in Azure Key Vault.<br/><br/>Example: `https://<key-vault-name>.vault.azure.net/secrets/<secret-name>/<version>`|
130
-
|**Authorization URL**| OAuth 2.0 authorization endpoint for the identity provider.<br/><br/>Example for Microsoft Entra ID: `https://login.microsoftonline.com/<tenant>/oauth2/v2.0/authorize`|
131
-
|**Token URL**| OAuth 2.0 token endpoint for the identity provider.<br/><br/>Example for Microsoft Entra ID: `https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token`|
132
-
|**Refresh URL**| OAuth 2.0 token refresh endpoint for the identity provider. For most providers, same as the **Token URL**<br/><br/>Example for Microsoft Entra ID: `https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token`|
133
-
|**OAuth2 flow**|One or both of the OAuth 2.0 flows that you want to use. Available values are **Authorization code (PKCE)** and **Client credentials**. |
134
-
|**Scopes**|One or more API scopes configured for your API, separated by spaces. If no scopes are configured, enter `.default`. |
128
+
|**Client ID**|Enter the client ID (GUID) of the app that you created in your identity provider. |
129
+
|**Client secret**|Click **Select** and select the subscription, key vault, and client secret that you stored.<br/><br/>Example: `https://<key-vault-name>.vault.azure.net/secrets/<secret-name>`|
130
+
|**Authorization URL**|Enter the OAuth 2.0 authorization endpoint for the identity provider.<br/><br/>Example for Microsoft Entra ID: `https://login.microsoftonline.com/<tenant>/oauth2/v2.0/authorize`|
131
+
|**Token URL**|Enter the OAuth 2.0 token endpoint for the identity provider.<br/><br/>Example for Microsoft Entra ID: `https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token`|
132
+
|**Refresh URL**|Enter the OAuth 2.0 token refresh endpoint for the identity provider. For most providers, same as the **Token URL**<br/><br/>Example for Microsoft Entra ID: `https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token`|
133
+
|**OAuth2 flow**|Select one or both of the OAuth 2.0 flows that you want to use. Available values are **Authorization code (PKCE)** and **Client credentials**. |
134
+
|**Scopes**|Enter one or more API scopes configured for your API, separated by spaces. If no scopes are configured, enter `.default`. |
Copy file name to clipboardExpand all lines: articles/api-center/includes/store-secret-key-vault.md
-3Lines changed: 0 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,6 @@ ms.custom: Include file
14
14
15
15
To store the API key as a secret in the key vault, see [Set and retrieve secret in Key Vault](/azure/key-vault/secrets/quick-create-portal).
16
16
17
-
> [!NOTE]
18
-
> The *secret identifier* of the secret appears on the secret's details page. This is a URI of the form `https://<key-vault-name>.vault.azure.net/secrets/<secret-name>/<version>`. You need this value when you configure the secret in your API center.
19
-
20
17
#### Enable a managed identity in your API center
21
18
22
19
For this scenario, your API center uses a [managed identity](/entra/identity/managed-identities-azure-resources/overview) to access the key vault. Depending on your needs, enable either a system-assigned or one or more user-assigned managed identities.
0 commit comments