Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 5.01 KB

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

File metadata and controls

86 lines (56 loc) · 5.01 KB
title description services author ms.service ms.topic ms.date ms.author
How to manage user accounts in Azure API Management
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.
api-management
dlepow
azure-api-management
how-to
12/04/2024
danlep

How to manage user accounts in Azure API Management

[!INCLUDE api-management-availability-premium-dev-standard-basic-premiumv2-standardv2-basicv2]

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 documentation in the API Management REST API reference.

Prerequisites

[!INCLUDE api-management-navigate-to-instance.md]

Create a new developer

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

  1. In the left menu, under Developer portal, select Users.

  2. Select + Add.

  3. Enter appropriate information for the user.

  4. Select Add.

    :::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.":::

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.

Invite a developer

To invite a developer, follow the steps in this section:

  1. In the left menu, under Developer portal, select Users.
  2. Select + Invite.
  3. Enter appropriate information for the user, including the email address.
  4. Select Send invitation.

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.

The developer can accept the invitation by following the instructions in the email. Once the invitation is accepted, the account becomes Active.

The invitation link is active for 2 days.

Deactivate or reactivate a developer account

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.

To block a user, follow the following steps.

  1. In the left menu, under Developer portal, select Users.
  2. Select the user that you want to block.
  3. In the top bar, select Block.

Reset a user password

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:

  1. In the left menu, under Developer portal, select Users.
  2. Select the user whose password you want to reset.
  3. In the top bar, select Reset password.
  4. To send a password reset email, select Yes.

Like the invitation email, this email is generated using a template and is customizable.

The developer can reset their password by following the instructions in the email.

To programmatically work with user accounts, see the User entity documentation in the API Management REST API reference. To reset a user account password to a specific value, you can use the Update a user operation and specify the desired password.

Related content

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.