How to create and use groups to manage developer accounts in Azure API Management

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.

API Management has the following immutable system groups:

  • 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.
  • 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.
  • 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.

In addition to these system groups, administrators can create custom groups or 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.

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

In addition to creating and managing groups in the publisher portal, you can create and manage your groups using the API Management REST API Group entity.

Prerequisites

Complete tasks in this article: Create an Azure API Management instance.

To navigate to your APIM instance, follow these steps:

  1. Sign in to the Azure portal.
  2. On the top-left of the screen, select All services.
  3. Type "api" in the search box.
  4. Click API Management services.

    Navigate

  5. Select your APIM service instance.

Tip

Add API Management (APIM) to your favorites in the Azure portal by clicking the star.
This adds the APIM icon to the menu on the left of the portal. To see all your APIM services, click the icon (APIM icon).

Create a group

This section shows how to add a new group to your API Management account.

  1. Select the Groups tab to the left of the screen.
  2. Click +Add.
  3. Enter a unique name for the group and an optional description.
  4. Press Create.

    Add a new group

Once the group is created, it is added to the Groups list.
To edit the Name or Description of the group, click the name of the group and Settings.
To delete the group, click the name of the group and press Delete.

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

Associate a group with a product

  1. Select the Products tab to the left.
  2. Click the name of the desired product.
  3. Press Access control.
  4. Click + Add group.

    Associate a group with a product

  5. Select the group you want to add.

    Associate a group with a product

    To remove a group from the product, click Delete.

    Delete a group

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

Associate groups with developers

This section shows how to associate groups with members.

  1. Select the Groups tab to the left of the screen.
  2. Select Members.

    Add a member

  3. Press +Add and select a member.

    Add a member

  4. Press Select.

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

Next steps

  • 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 create and publish a product in Azure API Management,
  • In addition to creating and managing groups in the publisher portal, you can create and manage your groups using the API Management REST API Group entity.