Skip to content

Commit d4fa18c

Browse files
Merge pull request #231272 from dlepow/group
[APIM] Freshness - groups content
2 parents e0f60bc + c90e0a2 commit d4fa18c

File tree

9 files changed

+32
-34
lines changed

9 files changed

+32
-34
lines changed

articles/api-management/api-management-howto-aad.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ description: Learn how to enable user sign-in to the API Management developer po
66
author: dlepow
77
ms.service: api-management
88
ms.topic: article
9-
ms.date: 07/12/2022
9+
ms.date: 03/17/2023
1010
ms.author: danlep
11+
ms.custom: engagement-fy23
1112
---
1213

1314
# Authorize developer accounts by using Azure Active Directory in Azure API Management
@@ -154,6 +155,7 @@ Now that you've enabled access for users in an Azure AD tenant, you can:
154155
Follow these steps to grant:
155156
* `User.Read` **delegated** permission for Microsoft Graph API.
156157
* `Directory.ReadAll` **application** permission for Microsoft Graph API.
158+
157159
1. Update the first 3 lines of the following Azure CLI script to match your environment and run it.
158160

159161
```azurecli
@@ -177,7 +179,8 @@ Now you can add external Azure AD groups from the **Groups** tab of your API Man
177179
1. Under **Developer portal** in the side menu, select **Groups**.
178180
1. Select the **Add Azure AD group** button.
179181

180-
!["Screenshot showing Add Azure AD group button.](./media/api-management-howto-aad/api-management-with-aad008.png)
182+
:::image type="content" source="media/api-management-howto-aad/api-management-with-aad008.png" alt-text="Screenshot showing Add Azure AD group button in the portal.":::
183+
181184
1. Select the **Tenant** from the drop-down.
182185
1. Search for and select the group that you want to add.
183186
1. Press the **Select** button.
@@ -191,7 +194,7 @@ Users from the configured Azure AD instance can now:
191194
* View and subscribe to any groups for which they have visibility.
192195

193196
> [!NOTE]
194-
> Learn more about the difference between **Delegated** and **Application** permissions types in [Permissions and consent in the Microsoft identity platform](../active-directory/develop/v2-permissions-and-consent.md#permission-types) article.
197+
> Learn more about the difference between **Delegated** and **Application** permissions types in [Permissions and consent in the Microsoft identity platform](../active-directory/develop/v2-permissions-and-consent.md#permission-types) article.
195198
196199
## <a id="log_in_to_dev_portal"></a> Developer portal: Add Azure AD account authentication
197200

articles/api-management/api-management-howto-create-groups.md

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,13 @@
22
title: Manage developer accounts using groups in Azure API Management
33
titleSuffix: Azure API Management
44
description: Learn how to manage developer accounts using groups in Azure API Management. Create groups, and then associate them with products or developers.
5-
services: api-management
6-
documentationcenter: ''
7-
author: dlepow
8-
manager: cfowler
9-
editor: ''
105

6+
author: dlepow
117
ms.service: api-management
12-
ms.workload: mobile
13-
ms.tgt_pltfrm: na
148
ms.topic: article
15-
ms.date: 02/13/2018
9+
ms.date: 03/17/2023
1610
ms.author: danlep
11+
ms.custom: engagement-fy23
1712
---
1813
# How to create and use groups to manage developer accounts in Azure API Management
1914

@@ -29,7 +24,7 @@ API Management has the following immutable system groups:
2924
* **Developers** - Authenticated developer portal users fall into this group. Developers are the customers that build applications using your APIs. Developers are granted access to the developer portal and build applications that call the operations of an API.
3025
* **Guests** - Unauthenticated developer portal users, such as prospective customers visiting the developer portal of an API Management instance fall into this group. They can be granted certain read-only access, such as the ability to view APIs but not call them.
3126

32-
In addition to these system groups, administrators can create custom groups or [leverage external groups in associated Azure Active Directory tenants][leverage external groups in associated Azure Active Directory tenants]. Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. A user can be a member of more than one group.
27+
In addition to these system groups, administrators can create custom groups or [use external groups in associated Azure Active Directory tenants][leverage external groups in associated Azure Active Directory tenants]. Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. A user can be a member of more than one group.
3328

3429
This guide shows how administrators of an API Management instance can add new groups and associate them with products and developers.
3530

@@ -48,49 +43,49 @@ Complete tasks in this article: [Create an Azure API Management instance](get-st
4843
This section shows how to add a new group to your API Management account.
4944

5045
1. Select the **Groups** tab to the left of the screen.
51-
2. Click **+Add**.
52-
3. Enter a unique name for the group and an optional description.
53-
4. Press **Create**.
46+
1. Click **+Add**.
47+
1. Enter a unique name for the group and an optional description.
48+
1. Press **Create**.
5449

55-
![Add a new group](./media/api-management-howto-create-groups/groups001.png)
50+
:::image type="content" source="media/api-management-howto-create-groups/groups001.png" alt-text="Screenshot of creating a group in the portal.":::
51+
Once the group is created, it's added to the **Groups** list.
52+
* To edit the **Name** or **Description** of the group, click the name of the group and select **Settings**
5653

57-
Once the group is created, it is added to the **Groups** list. <br/>To edit the **Name** or **Description** of the group, click the name of the group and **Settings**.<br/>To delete the group, click the name of the group and press **Delete**.
54+
* To delete the group, click the name of the group and press **Delete**.
5855

5956
Now that the group is created, it can be associated with products and developers.
6057

6158
## <a name="associate-group-product"> </a>Associate a group with a product
6259

6360
1. Select the **Products** tab to the left.
64-
2. Click the name of the desired product.
65-
3. Press **Access control**.
66-
4. Click **+ Add group**.
67-
68-
![Screenshot that highlights the Add group button.](./media/api-management-howto-create-groups/groups002.png)
69-
5. Select the group you want to add.
70-
71-
![Screenshot that shows the selected group and highlights the Select button.](./media/api-management-howto-create-groups/groups003.png)
72-
73-
To remove a group from the product, click **Delete**.
61+
1. Click the name of the desired product.
62+
1. Press **Access control** > **+ Add group**.
63+
1. Select the group you want to add.
7464

75-
![Delete a group](./media/api-management-howto-create-groups/groups004.png)
65+
:::image type="content" source="media/api-management-howto-create-groups/groups002.png" alt-text="Screenshot of adding a group to a product in the portal.":::
7666

7767
Once a product is associated with a group, developers in that group can view and subscribe to the product.
7868

7969
> [!NOTE]
8070
> To add Azure Active Directory groups, see [How to authorize developer accounts using Azure Active Directory in Azure API Management](api-management-howto-aad.md).
8171
72+
To remove a group from the product, click **Delete**.
73+
74+
:::image type="content" source="media/api-management-howto-create-groups/groups004.png" alt-text="Screenshot of removing a group from a product in the portal.":::
75+
8276
## <a name="associate-group-developer"> </a>Associate groups with developers
8377

8478
This section shows how to associate groups with members.
8579

86-
1. Select the **Groups** tab to the left of the screen.
87-
2. Select **Members**.
80+
1. Select the **Groups** tab to the left of the screen, and then select a group.
81+
1. Select **Members** > **+ Add**.
82+
83+
84+
1. Select a member.
8885

89-
![Add a member](./media/api-management-howto-create-groups/groups005.png)
90-
3. Press **+Add** and select a member.
86+
:::image type="content" source="media/api-management-howto-create-groups/groups006.png" alt-text="Screenshot of adding a member to a group in the portal.":::
9187

92-
![Screenshot that highlights the Add button, the selected user, and the Select button.](./media/api-management-howto-create-groups/groups006.png)
93-
4. Press **Select**.
88+
1. Press **Select**.
9489

9590
Once the association is added between the developer and the group, you can view it in the **Users** tab.
9691

74.7 KB
Loading
79 KB
Loading
55.7 KB
Loading
Binary file not shown.
49.6 KB
Loading
Binary file not shown.
38.2 KB
Loading

0 commit comments

Comments
 (0)