Skip to content

Commit fbb23b2

Browse files
Merge pull request #286073 from dlepow/grp
[APIM] Administrators group
2 parents 23094c7 + 9584e5b commit fbb23b2

File tree

4 files changed

+16
-19
lines changed

4 files changed

+16
-19
lines changed

articles/api-management/api-management-howto-add-products.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ In this tutorial, you learn how to:
5050
|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5151
| Display name | The name as you want it to be shown in the [developer portal](api-management-howto-developer-portal.md). |
5252
| Description | Provide information about the product such as its purpose, the APIs it provides access to, and other details. |
53-
| State | Select **Published** if you want to publish the product. Before the APIs in a product can be called, the product must be published. By default, new products are unpublished, and are visible only to the **Administrators** group. |
53+
| State | Select **Published** if you want to publish the product to the developer portal. Before the APIs in a product can be discovered by developers, the product must be published. By default, new products are unpublished. |
5454
| Requires subscription | Select if a user is required to subscribe to use the product (the product is *protected*) and a subscription key must be used to access the product's APIs. If a subscription isn't required (the product is *open*), a subscription key isn't required to access the product's APIs. See [Access to product APIs](#access-to-product-apis) later in this article. |
5555
| Requires approval | Select if you want an administrator to review and accept or reject subscription attempts to this product. If not selected, subscription attempts are auto-approved. |
5656
| Subscription count limit | Optionally limit the count of multiple simultaneous subscriptions. |
@@ -83,7 +83,7 @@ You can specify various values for your product:
8383
|-----------|-------------|
8484
| `--product-name` | The name as you want it to be shown in the [developer portal](api-management-howto-developer-portal.md). |
8585
| `--description` | Provide information about the product such as its purpose, the APIs it provides access to, and other details. |
86-
| `--state` | Select **published** if you want to publish the product. Before the APIs in a product can be called, the product must be published. By default, new products are unpublished, and are visible only to the **Administrators** group. |
86+
| `--state` | Select **published** if you want to publish the product to the developer portal. Before the APIs in a product can be discovered by developers, the product must be published. By default, new products are unpublished. |
8787
| `--subscription-required` | Select if a user is required to subscribe to use the product (the product is *protected*) or a subscription isn't required (the product is *open*). See [Access to product APIs](#access-to-product-apis) later in this article. |
8888
| `--approval-required` | Select if you want an administrator to review and accept or reject subscription attempts to this product. If not selected, subscription attempts are auto-approved. |
8989
| `--subscriptions-limit` | Optionally, limit the count of multiple simultaneous subscriptions.|

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
2-
title: Manage developer accounts using groups in Azure API Management
2+
title: Manage developer accounts using groups - 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.
55

66
author: dlepow
77
ms.service: azure-api-management
8-
ms.topic: article
9-
ms.date: 03/17/2023
8+
ms.topic: concept-article
9+
ms.date: 09/03/2024
1010
ms.author: danlep
1111
ms.custom: engagement-fy23
1212
---
1313
# How to create and use groups to manage developer accounts in Azure API Management
1414

1515
[!INCLUDE [api-management-availability-premium-dev-standard-basic-standardv2-basicv2](../../includes/api-management-availability-premium-dev-standard-basic-standardv2-basicv2.md)]
1616

17-
In API Management, groups are used to manage the visibility of products to developers. Products are first made visible to groups, and then developers in those groups can view and subscribe to the products that are associated with the groups.
17+
In API Management, groups are used to manage the visibility of products to developers in the developer portal. Products are first made visible to groups, and then developers in those groups can view and subscribe to the products that are associated with the groups.
1818

19-
API Management has the following immutable system groups:
19+
API Management has the following immutable groups:
2020

21-
* **Administrators** - Azure subscription administrators are members of this group. Administrators manage API Management service instances, creating the APIs, operations, and products that are used by developers. You can't add users to this group.
21+
* **Administrators** - Built-in group containing only the administrator email account provided at the time of service creation. Its membership is managed by the system; users can't be added to or removed from the group. The primary purpose of the administrator account is to access the developer portal's administrative interface to [customize and publish](api-management-howto-developer-portal-customize.md) the portal content. Any user that has [Azure RBAC permissions](/azure/api-management/developer-portal-faq#what-permissions-do-i-need-to-edit-the-developer-portal) to customize the developer portal can authenticate as the administrator to customize the portal.
2222

2323
> [!NOTE]
24-
> You can change the administrator [email settings](api-management-howto-configure-notifications.md#configure-email-settings) that are used in notifications sent to developers from your API Management instance.
24+
> At any time, a service owner can update the administrator [email settings](api-management-howto-configure-notifications.md#configure-email-settings) that are used in notifications from your API Management instance.
2525
2626
* **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.
2727
* **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.
@@ -51,7 +51,7 @@ This section shows how to add a new group to your API Management account.
5151
Once the group is created, it's added to the **Groups** list.
5252
* To edit the **Name** or **Description** of the group, click the name of the group and select **Settings**
5353

54-
* To delete the group, click the name of the group and press **Delete**.
54+
* To delete the group, select the name of the group and press **Delete**.
5555

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

@@ -89,7 +89,7 @@ This section shows how to associate groups with members.
8989

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

92-
## <a name="next-steps"> </a>Next steps
92+
## <a name="next-steps"> </a>Related content
9393

9494
* Once a developer is added to a group, they can view and subscribe to the products associated with that group. For more information, see [How to create and publish a product in Azure API Management][How create and publish a product in Azure API Management].
9595
* You can control how the developer portal content appears to different users and groups you've configured. Learn more about [visibility and access controls in the developer portal](developer-portal-overview.md#content-visibility-and-access).

articles/api-management/api-management-key-concepts.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -157,20 +157,17 @@ When a product is ready for use by developers, it can be published. Once publish
157157

158158
### Groups
159159

160-
Groups are used to manage the visibility of products to developers. API Management has the following built-in groups:
161-
162-
* **Administrators** - Manage API Management service instances and create the APIs, operations, and products that are used by developers.
163-
164-
Azure subscription administrators are members of this group.
160+
Groups are used to manage the visibility of products to developers. API Management has the following built-in groups for developers:
165161

166162
* **Developers** - Authenticated developer portal users that build applications using your APIs. Developers are granted access to the developer portal and build applications that call the operations of an API.
167163

168164
* **Guests** - Unauthenticated developer portal users, such as prospective customers visiting the developer portal. They can be granted certain read-only access, such as the ability to view APIs but not call them.
169165

170-
Administrators can also create custom groups or use external groups in an [associated Microsoft Entra tenant](api-management-howto-aad.md) to give developers visibility and access to API products. For example, create a custom group for developers in a partner organization to access a specific subset of APIs in a product. A user can belong to more than one group.
166+
API Management service owners can also create custom groups or use external groups in an [associated Microsoft Entra tenant](api-management-howto-aad.md) to give developers visibility and access to API products. For example, create a custom group for developers in a partner organization to access a specific subset of APIs in a product. A user can belong to more than one group.
171167

172168
**More information**:
173169
* [How to create and use groups][How to create and use groups]
170+
* [How to manage user accounts](api-management-howto-create-or-invite-developers.md)
174171

175172
### Developers
176173

@@ -184,7 +181,7 @@ When developers subscribe to a product, they're granted the primary and secondar
184181

185182
### Workspaces
186183

187-
Workspaces allow decentralized API development teams to manage and productize their own APIs, while a central API platform team maintains the API Management infrastructure. Each workspace contains APIs, products, subscriptions, and related entities that are accessible only to the workspace collaborators. Access is controlled through Azure role-based access control (RBAC).
184+
Workspaces allow decentralized API development teams to manage and productize their own APIs, while a central API platform team maintains the API Management infrastructure. Each workspace contains APIs, products, subscriptions, and related entities that are accessible only to the workspace collaborators. Access is controlled through Azure role-based access control (RBAC). Each workspace is associated with a workspace gateway that routes API traffic to its backend services.
188185

189186
**More information**:
190187

articles/api-management/get-started-create-service-instance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Sign in to the [Azure portal](https://portal.azure.com).
4545
| **Region** | Select a geographic region near you from the available API Management service locations. |
4646
| **Resource name** | A unique name for your API Management instance. The name can't be changed later. The service name refers to both the service and the corresponding Azure resource. <br/><br/> The service name is used to generate a default domain name: *\<name\>.azure-api.net.* If you would like to configure a custom domain name later, see [Configure a custom domain](configure-custom-domain.md). |
4747
| **Organization name** | The name of your organization. This name is used in many places, including the title of the developer portal and sender of notification emails. |
48-
| **Administrator email** | The email address to which all the notifications from **API Management** will be sent. |
48+
| **Administrator email** | The email address to which all system notifications from **API Management** will be sent. |
4949
| **Pricing tier** | Select **Developer** tier to evaluate the service. This tier isn't for production use. For more information about scaling the API Management tiers, see [upgrade and scale](upgrade-and-scale.md). |
5050

5151
1. Select **Review + create**.

0 commit comments

Comments
 (0)