Skip to content

Commit fac5f9d

Browse files
author
Jill Grant
authored
Merge pull request #291448 from dlepow/apimuse
[APIM] Freshness/UUF - user accounts
2 parents dd93c56 + 6be8ade commit fac5f9d

13 files changed

+43
-46
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ API Management has the following immutable groups:
2323
> [!NOTE]
2424
> 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
26-
* **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.
26+
* **Developers** - Authenticated developer portal [users](api-management-howto-create-or-invite-developers.md) 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.
2828

2929
In addition to these system groups, administrators can create custom groups or [use external groups in associated Microsoft Entra 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.

articles/api-management/api-management-howto-create-or-invite-developers.md

Lines changed: 41 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,83 @@
11
---
2-
title: How to manage user accounts in Azure API Management | Microsoft Docs
3-
description: Learn how to create or invite users in Azure API Management. View additional resources to use after creating a developer account.
2+
title: How to manage user accounts in Azure API Management
3+
description: Learn how to create or invite users and manage developer accounts in Azure API Management. View additional resources to use after creating a developer account.
44
services: api-management
55
author: dlepow
6-
manager: cfowler
76
ms.service: azure-api-management
8-
ms.topic: article
9-
ms.date: 03/20/2024
7+
ms.topic: how-to
8+
ms.date: 12/04/2024
109
ms.author: danlep
1110
---
1211
# How to manage user accounts in Azure API Management
1312

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

16-
In API Management, developers are the users of the APIs that you expose using API Management. This guide shows how to create and invite developers to use the APIs and products that you make available to them with your API Management instance. For information on managing user accounts programmatically, see the [User entity](/rest/api/apimanagement/current-ga/user) documentation in the [API Management REST](/rest/api/apimanagement/) reference.
15+
In API Management, developers are the users of the APIs that you expose using API Management. This guide shows how to create and invite developers to use the APIs and products that you make available to them with your API Management instance. For information on managing user accounts programmatically, see the [User entity](/rest/api/apimanagement/user) documentation in the [API Management REST API](/rest/api/apimanagement/) reference.
1716

1817
## Prerequisites
1918

20-
Complete tasks in this article: [Create an Azure API Management instance](get-started-create-service-instance.md).
19+
* Complete tasks in this article: [Create an Azure API Management instance](get-started-create-service-instance.md).
20+
* If you created your instance in a v2 tier, enable the developer portal. For more information, see [Tutorial: Access and customize the developer portal](api-management-howto-developer-portal-customize.md).
2121

2222
[!INCLUDE [api-management-navigate-to-instance.md](../../includes/api-management-navigate-to-instance.md)]
2323

24-
## <a name="create-developer"> </a>Create a new developer
24+
## Create a new developer
2525

2626
To add a new user, follow the steps in this section:
2727

28-
1. Select the **Users** tab to the left of the screen.
29-
2. Press **+Add**.
30-
3. Enter appropriate information for the user.
31-
4. Press **Add**.
28+
1. In the left menu, under **Developer portal**, select **Users**.
29+
1. Select **+ Add**.
30+
1. Enter appropriate information for the user.
31+
1. Select **Add**.
3232

33-
![Add a new user](./media/api-management-howto-create-or-invite-developers/api-management-create-developer.png)
33+
:::image type="content" source="media/api-management-howto-create-or-invite-developers/api-management-create-developer.png" alt-text="Screenshot of adding a user in the portal.":::
3434

35-
By default, newly created developer accounts are **Active**, and associated with the **Developers** group. Developer accounts that are in an **active** state can be used to access all of the APIs for which they have subscriptions. To associate the newly created developer with additional groups, see [How to associate groups with developers][How to associate groups with developers].
35+
By default, newly created developer accounts are **Active**, and associated with the **Developers** group. Developer accounts that are in an **Active** state can be used to access the developer portal and all of the APIs for which they have subscriptions. To associate the newly created developer with additional groups, see [How to associate groups with developers][How to associate groups with developers].
3636

37-
## <a name="invite-developer"> </a>Invite a developer
38-
To invite a developer, follow the steps in this section:
37+
## Invite a developer
3938

40-
1. Select the **Users** tab to the left of the screen.
41-
2. Press **+Invite**.
39+
To invite a developer, follow the steps in this section:
4240

43-
A confirmation message is displayed, but the newly invited developer does not appear in the list until after they accept the invitation.
41+
1. In the left menu, under **Developer portal**, select **Users**.
42+
1. Select **+ Invite**.
43+
1. Enter appropriate information for the user, including the email address.
44+
1. Select **Send invitation**.
4445

45-
When a developer is invited, an email is sent to the developer. This email is generated using a template and is customizable. For more information, see [Configure email templates][Configure email templates].
46+
When a developer is invited, by default an email is sent to the developer. This email is generated using a template and is customizable. For more information, see [Configure email templates][Configure email templates].
4647

47-
Once the invitation is accepted, the account becomes active.
48+
The developer can accept the invitation by following the instructions in the email. Once the invitation is accepted, the account becomes **Active**.
4849

49-
Invitation link will be active for 2 days.
50+
The invitation link is active for 2 days.
5051

51-
## <a name="block-developer"> </a> Deactivate or reactivate a developer account
52+
## Deactivate or reactivate a developer account
5253

53-
By default, newly created or invited developer accounts are **Active**. To deactivate a developer account, click **Block**. To reactivate a blocked developer account, click **Activate**. A blocked developer account can't access the developer portal or call any APIs. To delete a user account, click **Delete**.
54+
To deactivate a developer account in the **Active** state, select **Block**. To reactivate a blocked developer account, select **Activate**. A blocked developer account can't access the developer portal or call any APIs. To delete a user account, select **Delete**.
5455

5556
To block a user, follow the following steps.
5657

57-
1. Select the **Users** tab to the left of the screen.
58-
2. Click on the user that you want to block.
59-
3. Press **Block**.
58+
1. In the left menu, under **Developer portal**, select **Users**.
59+
1. Select the user that you want to block.
60+
1. In the top bar, select **Block**.
6061

6162
## Reset a user password
6263

64+
When you create a developer account or a developer is invited, a password is set. You can send an email to a user to reset the password:
65+
66+
1. In the left menu, under **Developer portal**, select **Users**.
67+
1. Select the user whose password you want to reset.
68+
1. In the top bar, select **Reset password**.
69+
1. To send a password reset email, select **Yes**.
70+
71+
Like the invitation email, this email is generated using a template and is customizable.
72+
73+
The developer can reset their password by following the instructions in the email.
74+
6375
To programmatically work with user accounts, see the User entity documentation in the [API Management REST API](/rest/api/apimanagement/) reference. To reset a user account password to a specific value, you can use the [Update a user](/rest/api/apimanagement/apimanagementrest/azure-api-management-rest-api-user-entity#UpdateUser) operation and specify the desired password.
6476

65-
## <a name="next-steps"> </a>Next steps
77+
## Related content
78+
6679
Once a developer account is created, you can associate it with roles and subscribe it to products and APIs. For more information, see [How to create and use groups][How to create and use groups].
6780

68-
[api-management-management-console]: ./media/api-management-howto-create-or-invite-developers/api-management-management-console.png
69-
[api-management-add-new-user]: ./media/api-management-howto-create-or-invite-developers/api-management-add-new-user.png
70-
[api-management-create-developer]: ./media/api-management-howto-create-or-invite-developers/api-management-create-developer.png
71-
[api-management-invite-developer]: ./media/api-management-howto-create-or-invite-developers/api-management-invite-developer.png
72-
[api-management-new-developer]: ./media/api-management-howto-create-or-invite-developers/api-management-new-developer.png
73-
[api-management-invite-developer-window]: ./media/api-management-howto-create-or-invite-developers/api-management-invite-developer-window.png
74-
[api-management-invite-developer-confirmation]: ./media/api-management-howto-create-or-invite-developers/api-management-invite-developer-confirmation.png
75-
[api-management-pending-verification]: ./media/api-management-howto-create-or-invite-developers/api-management-pending-verification.png
76-
[api-management-view-developer]: ./media/api-management-howto-create-or-invite-developers/api-management-view-developer.png
77-
[api-management-reset-password]: ./media/api-management-howto-create-or-invite-developers/api-management-reset-password.png
78-
79-
80-
[Create a new developer]: #create-developer
81-
[Invite a developer]: #invite-developer
82-
[Deactivate or reactivate a developer account]: #block-developer
83-
[Next steps]: #next-steps
8481
[How to create and use groups]: api-management-howto-create-groups.md
8582
[How to associate groups with developers]: api-management-howto-create-groups.md#associate-group-developer
8683

articles/api-management/api-management-howto-developer-portal-customize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ For more information about developer portal features and options, see [Azure API
4242
Follow these steps to access the managed version of the developer portal.
4343

4444
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
45-
1. If you created your instance in a v2 service tier that supports the developer portal, first enable the developer portal.
45+
1. If you created your instance in a v2 service tier, first enable the developer portal.
4646
1. In the left menu, under **Developer portal**, select **Portal settings**.
4747
1. In the **Portal settings** window, select **Enabled**. Select **Save**.
4848

67.1 KB
Loading

0 commit comments

Comments
 (0)