Skip to content

Commit a5ced9d

Browse files
author
gitName
committed
edits
1 parent e1a3743 commit a5ced9d

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

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

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ 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/23/2025
7+
ms.date: 04/25/2025
88
ms.author: danlep
99
ms.custom:
10-
# Customer intent: As an API program manager, I want to ... TBD
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.
1111
---
1212

1313
# Authorize access to APIs in your API Center inventory
@@ -39,34 +39,35 @@ You can configure settings to authorize access to APIs in your API center invent
3939

4040
## Configure settings for API key authentication
4141

42-
Follow these steps to configure settings for API key authentication. The API key must be stored in Azure Key Vault, and access to the key vault is through your API center's managed identity.
42+
For an API that supports API key authentication, follow these steps to configure settings in your API center. The API key must be stored in Azure Key Vault, and access to the key vault is through your API center's managed identity.
4343

44-
### Store secret in Azure Key Vault
44+
### 1. Store secret in Azure Key Vault
4545

4646
To store the API key securely, use Azure Key Vault. You can create a new key vault or use an existing one, using the Azure portal, Azure tools, or Azure SDKs. Your key vault should use the Azure role-based access control (RBAC) permission model.
4747

4848
* For steps to create a key vault, see [Create a Key Vault](/azure/key-vault/general/quick-create-portal).
4949

50-
* 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).
50+
* 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).
5151

52-
Note the *secret identifier* of the secret. This is a URI of the form `https://<key-vault-name>.vault.azure.net/secrets/<secret-name>/<version>`. You need this value when you add the API key configuration in your API center.
52+
> [!NOTE]
53+
> 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 add the API key configuration in your API center.
5354
5455
<!-- Should we use the version of the secret in the URI? -->
5556

5657

57-
### Enable a managed identity in your API center
58+
### 2. Enable a managed identity in your API center
5859

59-
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.
60+
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.
6061

61-
The following examples show 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.
62+
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.
6263

6364

6465
1. In the [portal](https://azure.microsoft.com), navigate to your API center.
6566
1. In the left menu, under **Security**, select **Managed identities**.
6667
1. Select **System assigned**, and set the status to **On**.
6768
1. Select **Save**.
6869

69-
### Assign the Key Vault Secrets User role to the managed identity
70+
### 3. Assign the Key Vault Secrets User role to the managed identity
7071

7172
Assign your API center's managed identity the **Key Vault Secrets User** role in your key vault. The following steps use the Azure portal.
7273

@@ -80,7 +81,7 @@ Assign your API center's managed identity the **Key Vault Secrets User** role in
8081
1. Select **Review + assign**.
8182

8283

83-
### Add API key configuration in your API center
84+
### 4. Add API key configuration in your API center
8485

8586
1. In the [portal](https://azure.microsoft.com), navigate to your key API center.
8687
1. In the left menu, under **Assets**, select **Authorization (preview)** > **+ Add configuration**.
@@ -98,45 +99,44 @@ Assign your API center's managed identity the **Key Vault Secrets User** role in
9899
<!-- Which identity providers are supported? Just Entra? -->
99100

100101

101-
Follow these steps to configure settings for OAuth 2.0 authorization to APIs. You can configure settings for one or both of the following OAuth 2.0 authorization flows:
102+
For an API that supports OAuth 2.0 authorization, follow these steps to configure authentication settings in your API center. You can configure settings for one or both of the following OAuth 2.0 authorization flows:
102103

103104
* **Authorization code flow with PKCE (Proof Key for Code Exchange)** - This flow is recommended for authenticating users in mobile and web applications such as the API Center portal.
104105
* **Client credentials flow** - This flow is recommended for machine-to-machine applications that don't require a specific user's permissions to access data, such as background services or daemons.
105106

106107

107-
### Create an OAuth 2.0 app
108+
### 1. Create an OAuth 2.0 app
108109

109-
For OAuth 2.0 authorization, create an app registration in an identity provider, such as the Microsoft Entra tenant associated with your Azure subscription. The exact steps depend on the identity provider you use. The following example shows how to create an app registration in the Microsoft Entra tenant associated with your Azure subscription.
110+
For OAuth 2.0 authorization, create an app registration in an identity provider, such as the Microsoft Entra tenant associated with your Azure subscription. The exact steps depend on the identity provider you use.
110111

112+
The following example shows how to create an app registration in Microsoft Entra ID.
111113

112-
Minimally you need to configure:
113-
114-
* A client secret for the app registration.
115-
* Any required scopes for the API.
116-
* A redirect URI for the app registration, when using the authorization code flow.
114+
<!-- NOT COMPLETE. What about Redirect URI? How to configure scopes? -->
117115

118116

119117
1. Sign in to the [Azure portal](https://portal.azure.com) with an account with sufficient permissions in the tenant.
120118
1. Navigate to **Microsoft Entra ID** > **+ New registration**.
121-
1. On the **Register an application** page, enter your application registration settings:
119+
1. In the **Register an application** page, enter your application registration settings:
122120
1. In **Name**, enter a meaningful name for the app.
123121
1. In **Supported account types**, select an option that suits your scenario, for example, **Accounts in this organizational directory only (Single tenant)**.
124122
1. Set the **Redirect URI** to **SPA**, and set the URI. Enter the URI of your API Center portal deployment, in the following form: `https://<service-name>.portal.<location>.azure-api-center.ms`
125123
1. Select **Register**.
126-
1. On the left menu, under **Manage**, select **Certificates & secrets**, and then select **+ New client secret**.
124+
1. In the left menu, under **Manage**, select **Certificates & secrets**, and then select **+ New client secret**.
127125
1. Enter a **Description**.
128126
1. Select an option for **Expires**.
129127
1. Select **Add**.
130128
1. Copy the client secret's **Value** before leaving the page. You will need it in the following section.
129+
1. Optionally, to configure API scopes for your app registration, see [Configure an application to expose a web API](/entra/identity-platform/quickstart-configure-app-expose-web-apis#add-a-scope).
130+
131+
In the following section, you will need the following values from the app registration:
131132

132-
In the following section, you will need the following values:
133-
134-
* The **Application (client) ID** and **Directory (tenant) ID** values from the app registration's **Overview** page.
135-
* The following endpoints on the app registration's **Overview** > **Endpoints** page:
133+
* The **Application (client) ID** from the app registration's **Overview** page, and the **Client secret** you copied previously.
134+
* The following endpoint URLs on the app registration's **Overview** > **Endpoints** page:
136135
* **OAuth2.0 authorization endpoint (v2)** - the authorization endpoint for Microsoft Entra ID
137-
* **OAuth 2.0tToken endpoint** - the token URL for Microsoft Entra ID.
136+
* **OAuth 2.0 token endpoint (v2)** - the token URL endpoint for Microsoft Entra ID
137+
* Any scopes configured for the app registration.
138138

139-
### Add OAuth 2.0 authorization in your API center
139+
### 2. Add OAuth 2.0 authorization in your API center
140140

141141
1. In the [portal](https://azure.microsoft.com), navigate to your key API center.
142142
1. In the left menu, under **Assets**, select **Authorization (preview)** > **+ Add configuration**.
@@ -153,7 +153,7 @@ In the following section, you will need the following values:
153153

154154
## Add authentication settings to an API version
155155

156-
After configuring settings for an API key or an OAuth 2.0 flow, add the API key or OAuth 2.0 authentication to an API versions in your inventory.
156+
After configuring settings for an API key or an OAuth 2.0 flow, add the API key or OAuth 2.0 authentication method to an API version in your inventory.
157157

158158
1. In the [portal](https://azure.microsoft.com), navigate to your key API center.
159159
1. In the left menu, under **Assets**, select **APIs**.
@@ -181,7 +181,7 @@ You can limit access to the authentication settings associated with an API to sp
181181
1. Click **Select**.
182182

183183
> [!TIP]
184-
> You can also remove users or groups from the access policy. In the **Manage access** page, select **Delete** in the context (...) menu for the user or group.
184+
> You can also remove users or groups from the access policy. In the **Manage access** page, select **Delete** in the context (...) menu for the user or group.
185185
186186
## Test API in API Center portal
187187

0 commit comments

Comments
 (0)