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-management/api-management-howto-create-groups.md
+25-30Lines changed: 25 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,13 @@
2
2
title: Manage developer accounts using groups in Azure API Management
3
3
titleSuffix: Azure API Management
4
4
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: ''
10
5
6
+
author: dlepow
11
7
ms.service: api-management
12
-
ms.workload: mobile
13
-
ms.tgt_pltfrm: na
14
8
ms.topic: article
15
9
ms.date: 03/17/2023
16
10
ms.author: danlep
11
+
ms.custom: engagement-fy23
17
12
---
18
13
# How to create and use groups to manage developer accounts in Azure API Management
19
14
@@ -29,7 +24,7 @@ API Management has the following immutable system groups:
29
24
***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.
30
25
***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.
31
26
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.
33
28
34
29
This guide shows how administrators of an API Management instance can add new groups and associate them with products and developers.
35
30
@@ -48,49 +43,49 @@ Complete tasks in this article: [Create an Azure API Management instance](get-st
48
43
This section shows how to add a new group to your API Management account.
49
44
50
45
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**.
54
49
55
-

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**
56
53
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**.
58
55
59
56
Now that the group is created, it can be associated with products and developers.
60
57
61
58
## <aname="associate-group-product"> </a>Associate a group with a product
62
59
63
60
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
-

69
-
5. Select the group you want to add.
70
-
71
-

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.
74
64
75
-

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.":::
76
66
77
67
Once a product is associated with a group, developers in that group can view and subscribe to the product.
78
68
79
69
> [!NOTE]
80
70
> 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).
81
71
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
+
82
76
## <aname="associate-group-developer"> </a>Associate groups with developers
83
77
84
78
This section shows how to associate groups with members.
85
79
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.
88
85
89
-

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.":::
91
87
92
-

93
-
4. Press **Select**.
88
+
1. Press **Select**.
94
89
95
90
Once the association is added between the developer and the group, you can view it in the **Users** tab.
0 commit comments