Skip to content

Commit 2699e0f

Browse files
Merge pull request #300685 from dlepow/apickv
[APIC] UX updates: select secret from KV, integrations
2 parents d48f592 + 3067742 commit 2699e0f

File tree

7 files changed

+24
-26
lines changed

7 files changed

+24
-26
lines changed

articles/api-center/authorize-api-access.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to configure access to APIs in the Azure API Center inven
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 04/30/2025
7+
ms.date: 06/02/2025
88
ms.author: danlep
99
ms.custom:
1010
# 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
5757

5858
| **Setting** | **Description** |
5959
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
60-
| **Title** | A name for the authorization. |
61-
| **Description** | Optional description for the authorization. |
60+
| **Title** | Enter a name for the authorization. |
61+
| **Description** | Optionally, enter a description for the authorization. |
6262
| **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>` |
6666

6767
1. Select **Create**.
6868

@@ -114,24 +114,24 @@ To manage the secret securely, store it in Azure Key Vault, and access the key v
114114
1. In the left menu, under **Governance**, select **Authorization (preview)** > **+ Add configuration**.
115115
1. In the **Add configuration** page, set the values as follows:
116116

117-
:::image type="content" source="media/authorize-api-access/configure-oauth.png" alt-text="Screenshot of configuring OAuth 2.0 in the portal.":::
117+
:::image type="content" source="media/authorize-api-access/configure-oauth.png" lightbox="media/authorize-api-access/configure-oauth.png" alt-text="Screenshot of configuring OAuth 2.0 in the portal.":::
118118

119119

120120
> [!NOTE]
121121
> Configure settings based on the app registration you created previously in your identity provider. If you're using Microsoft Entra ID, find the **Client ID** on the **Overview** page of the app registration, and find the URL endpoints on the **Overview** > **Endpoints** page.
122122
123123
| **Setting** | **Description** |
124124
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
125-
| **Title** | A name for the authorization. |
126-
| **Description** | Optional description for the authorization. |
125+
| **Title** | Enter a name for the authorization. |
126+
| **Description** | Optionally, enter a description for the authorization. |
127127
| **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`. |
135135

136136
1. Select **Create** to save the configuration.
137137

articles/api-center/includes/store-secret-key-vault.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ ms.custom: Include file
1414

1515
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).
1616

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-
2017
#### Enable a managed identity in your API center
2118

2219
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.
-2.35 KB
Loading
-2.64 KB
Loading
-7.49 KB
Loading

articles/api-center/synchronize-api-management-apis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Integrate an API Management instance to Azure API Center for automa
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 01/23/2025
7+
ms.date: 06/02/2025
88
ms.author: danlep
99
ms.custom: devx-track-azurecli
1010
# Customer intent: As an API program manager, I want to integrate my Azure API Management instance with my API center and synchronize API Management APIs to my inventory.
@@ -66,8 +66,8 @@ You can integrate an API Management instance using the portal or the Azure CLI.
6666
#### [Portal](#tab/portal)
6767

6868
1. In the [portal](https://portal.azure.com), navigate to your API center.
69-
1. Under **Assets**, select **Environments**.
70-
1. Select **Integrations (preview)** > **+ New integration** > **From Azure API Management**.
69+
1. Under **Platforms**, select **Integrations**.
70+
1. Select **+ New integration** > **From Azure API Management**.
7171
1. In the **Integrate your Azure API Management Service** page:
7272
1. Select the **Subscription**, **Resource group**, and **Azure API Management service** that you want to integrate.
7373
1. In **Integration details**, enter an identifier.

articles/api-center/synchronize-aws-gateway-apis.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Integrate an Amazon API Gateway to Azure API Center for automatic s
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 02/10/2025
7+
ms.date: 06/02/2025
88
ms.author: danlep
99
ms.custom:
1010
- devx-track-azurecli
@@ -97,10 +97,11 @@ You can integrate an Amazon API Gateway using the portal or the Azure CLI.
9797

9898
#### [Portal](#tab/portal)
9999
1. In the [portal](https://portal.azure.com), navigate to your API center.
100-
1. Under **Assets**, select **Environments**.
101-
1. Select **Integrations (preview)** > **+ New integration** > **From Amazon API Gateway**.
100+
1. Under **Platforms**, select **Integrations**.
101+
1. Select **+ New integration** > **From Amazon API Gateway**.
102102
1. In the **Integrate your Amazon API Gateway Service** page:
103-
1. Enter the Key Vault secret identifiers for the AWS access key and secret access key, and the AWS region where the Amazon API Gateway is deployed.
103+
1. For the **AWS access key** and **AWS secret access key**, click **Select** and select the subscription, key vault, secret that you stored.
104+
1. Select the **AWS region** where the Amazon API Gateway is deployed.
104105
1. In **Integration details**, enter an identifier.
105106
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Description**.
106107
1. In **API Details**:

0 commit comments

Comments
 (0)