Skip to content

Commit 4acd0c0

Browse files
committed
review
1 parent 0ca766a commit 4acd0c0

7 files changed

Lines changed: 36 additions & 106 deletions

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

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,18 @@ For an API that supports API key authentication, complete the following steps.
4343

4444
### 1. Store API key in Azure Key Vault
4545

46-
Store the API key in Azure Key Vault, and access the key vault using your API center's managed identity.
46+
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).
4747

48-
[!INCLUDE [store-secret-key-vault](includes/store-secret-key-vault.md)]
48+
Access the key vault using your API center's managed identity.
49+
50+
51+
#### Enable a managed identity in your API center
52+
53+
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
54+
55+
#### Assign the managed identity the Key Vault Secrets User role
56+
57+
[!INCLUDE [configure-managed-identity-kv-secret-user](includes/configure-managed-identity-kv-secret-user.md)]
4958

5059

5160
### 2. Add API key configuration
@@ -103,9 +112,18 @@ When configuring OAuth 2.0 in your API center, you need the following values fro
103112

104113
### 2. Store client secret in Azure Key Vault
105114

106-
Store the secret in Azure Key Vault. Access the key vault using your API center's managed identity.
115+
To store the client secret in the key vault, see [Set and retrieve secret in Key Vault](/azure/key-vault/secrets/quick-create-portal).
116+
117+
Access the key vault using your API center's managed identity.
118+
119+
120+
#### Enable a managed identity in your API center
121+
122+
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
123+
124+
#### Assign the managed identity the Key Vault Secrets User role
107125

108-
[!INCLUDE [store-secret-key-vault](includes/store-secret-key-vault.md)]
126+
[!INCLUDE [configure-managed-identity-kv-secret-user](includes/configure-managed-identity-kv-secret-user.md)]
109127

110128
### 3. Add OAuth 2.0 configuration
111129

@@ -134,9 +152,9 @@ Store the secret in Azure Key Vault. Access the key vault using your API center'
134152

135153
1. Select **Create** to save the configuration.
136154

137-
### Option 3: Configure settings for another HTTP security scheme
155+
## Option 3: Configure settings for another HTTP security scheme
138156

139-
For APIs that use another HTTP security scheme, such as Basic authentication or bearer tokens that don't use OAuth 2.0, complete the following steps. You might need to choose this for legacy APIs.
157+
For APIs that use another HTTP security scheme, such as Basic authentication or bearer tokens that don't use OAuth 2.0, complete the following steps. You might need to choose this option for legacy APIs.
140158

141159
In the [portal](https://azure.microsoft.com), go to your API center.
142160
1. Under **Governance**, select **Authorization (preview)** > **+ Add configuration**.
@@ -147,9 +165,9 @@ In the [portal](https://azure.microsoft.com), go to your API center.
147165
| **Title** | Enter a name for the authorization. |
148166
| **Description** | Optionally, enter a description for the authorization. |
149167
| **Security scheme** | Select **HTTP**. |
150-
| **Authentication scheme** | Select the authentication scheme used by the API. Examples include the schemes in the following table |
168+
| **Authentication scheme** | Select the authentication scheme used by the API. Examples include the schemes in the following table. |
151169

152-
| Scheme | Description |
170+
| Authentication scheme | Description |
153171
|---|---|
154172
| **Basic** | Sends `username:password` as a Base64-encoded string in the `Authorization: Basic <credentials>` header. |
155173
| **Bearer** | Sends a token other than an OAuth 2.0 access token in the `Authorization: Bearer <token>` header. |

articles/api-center/build-register-apis-vscode-extension.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

articles/api-center/includes/configure-managed-identity-kv-secret-user.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,5 @@ To allow import of APIs, assign your API center's managed identity the **Key Vau
7676
--assignee-object-id $apicObjID `
7777
--assignee-principal-type ServicePrincipal `
7878
--scope $scope
79+
```
7980
---

articles/api-center/includes/enable-managed-identity.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ ms.date: 12/20/2024
1111
ms.custom: Include file
1212
---
1313

14-
## Enable a managed identity in your API center
15-
1614
For this scenario, your API center uses a [managed identity](/entra/identity/managed-identities-azure-resources/overview) to access Azure resources. Depending on your needs, enable either a system-assigned or one or more user-assigned managed identities.
1715

1816
The following examples show how to enable a system-assigned managed identity by using the Azure portal or the Azure CLI. At a high level, configuration steps are similar for a user-assigned managed identity.

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

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,11 @@ 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-
#### Enable a managed identity in your API center
1817

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.
18+
### Enable a managed identity in your API center
2019

21-
The following example shows how to enable a system-assigned managed identity by using the Azure portal. At a high level, configuration steps are similar for a user-assigned managed identity.
20+
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
2221

22+
### Assign the managed identity the Key Vault Secrets User role
2323

24-
1. In the [portal](https://azure.microsoft.com), navigate to your API center.
25-
1. In the left menu, under **Security**, select **Managed identities**.
26-
1. Select **System assigned**, and set the status to **On**.
27-
1. Select **Save**.
28-
29-
#### Assign the Key Vault Secrets User role to the managed identity
30-
31-
Assign your API center's managed identity the **Key Vault Secrets User** role in your key vault. The following steps use the Azure portal.
32-
33-
1. In the [portal](https://azure.microsoft.com), navigate to your key vault.
34-
1. In the left menu, select **Access control (IAM)**.
35-
1. Select **+ Add** > **Add role assignment**.
36-
1. On the **Add role assignment** page, set the values as follows:
37-
1. On the **Role** tab, select **Key Vault Secrets User**.
38-
1. On the **Members** tab, in **Assign access to**, select **Managed identity** > **+ Select members**.
39-
1. On the **Select managed identities** page, select the system-assigned managed identity of your API center that you added in the previous section. Click **Select**.
40-
1. Select **Review + assign** twice.
24+
[!INCLUDE [configure-managed-identity-kv-secret-user](includes/configure-managed-identity-kv-secret-user.md)]

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,11 @@ API Management APIs automatically synchronize to the API center whenever existin
5353
> [!NOTE]
5454
> You can run Azure CLI command examples in this article in PowerShell or a bash shell. Where different variable syntax is required, the article provides separate command examples for the two shells.
5555
56+
## Enable a managed identity in your API center
57+
5658
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
5759

58-
## Assign the managed identity the API Management Service Reader role
60+
### Assign the managed identity the API Management Service Reader role
5961

6062
[!INCLUDE [configure-managed-identity-apim-reader](includes/configure-managed-identity-apim-reader.md)]
6163

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,11 @@ Manually upload and securely store the two IAM user access keys in Azure Key Vau
8383

8484
Take note of the **Secret identifier** of each secret, a URI similar to `https://<key-vault-name>.vault.azure.net/secrets/<secret-name>`. You use these identifiers in the next steps.
8585

86+
## Configure a managed identity for your API center
8687

8788
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
8889

89-
## Assign the managed identity the Key Vault Secrets User role
90+
### Assign the managed identity the Key Vault Secrets User role
9091

9192
[!INCLUDE [configure-managed-identity-kv-secret-user](includes/configure-managed-identity-kv-secret-user.md)]
9293

0 commit comments

Comments
 (0)