|
1 | 1 | ---
|
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. |
4 | 4 | services: api-management
|
5 | 5 | author: dlepow
|
6 |
| -manager: cfowler |
7 | 6 | 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 |
10 | 9 | ms.author: danlep
|
11 | 10 | ---
|
12 | 11 | # How to manage user accounts in Azure API Management
|
13 | 12 |
|
14 | 13 | [!INCLUDE [api-management-availability-premium-dev-standard-basic-premiumv2-standardv2-basicv2](../../includes/api-management-availability-premium-dev-standard-basic-premiumv2-standardv2-basicv2.md)]
|
15 | 14 |
|
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. |
17 | 16 |
|
18 | 17 | ## Prerequisites
|
19 | 18 |
|
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). |
21 | 21 |
|
22 | 22 | [!INCLUDE [api-management-navigate-to-instance.md](../../includes/api-management-navigate-to-instance.md)]
|
23 | 23 |
|
24 |
| -## <a name="create-developer"> </a>Create a new developer |
| 24 | +## Create a new developer |
25 | 25 |
|
26 | 26 | To add a new user, follow the steps in this section:
|
27 | 27 |
|
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**. |
32 | 32 |
|
33 |
| -  |
| 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."::: |
34 | 34 |
|
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]. |
36 | 36 |
|
37 |
| -## <a name="invite-developer"> </a>Invite a developer |
38 |
| -To invite a developer, follow the steps in this section: |
| 37 | +## Invite a developer |
39 | 38 |
|
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: |
42 | 40 |
|
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**. |
44 | 45 |
|
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]. |
46 | 47 |
|
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**. |
48 | 49 |
|
49 |
| -Invitation link will be active for 2 days. |
| 50 | +The invitation link is active for 2 days. |
50 | 51 |
|
51 |
| -## <a name="block-developer"> </a> Deactivate or reactivate a developer account |
| 52 | +## Deactivate or reactivate a developer account |
52 | 53 |
|
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**. |
54 | 55 |
|
55 | 56 | To block a user, follow the following steps.
|
56 | 57 |
|
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**. |
60 | 61 |
|
61 | 62 | ## Reset a user password
|
62 | 63 |
|
| 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 | + |
63 | 75 | 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.
|
64 | 76 |
|
65 |
| -## <a name="next-steps"> </a>Next steps |
| 77 | +## Related content |
| 78 | + |
66 | 79 | 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].
|
67 | 80 |
|
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 |
84 | 81 | [How to create and use groups]: api-management-howto-create-groups.md
|
85 | 82 | [How to associate groups with developers]: api-management-howto-create-groups.md#associate-group-developer
|
86 | 83 |
|
|
0 commit comments