Skip to content

API User Management

In this tutorial, you will learn how to manage user as part of API Management.


Introduction

User and user group management is an important aspect of API Management that involves the creation, modification, and deletion of user accounts and groups in order to manage access and permissions to APIs, API Gateways and API Portals.


User

Adding user

Select Users under API Management, here you will see all existing user, and you can validate and adjust their permissions and groups.

Select Add User on the right top corner to add a new user.

Select user management

User management UI

Fill out the form, all fields are required.

  • First name
  • Last name
  • Email
  • Company
  • Groups

User form

User form

Every user has to be part of a user group, it is not possible to assign an individual user to an API or API collection.

You can assign the user to an already existing user group, or you can create a new one.

Choose existing user group

Choose existing user group

Choose an existing user group and select Save.

If you want to create a new user group, choose Create new User Group.

Choose create new user group

Choose create new user group

Fill out the name of the new user group and select Create.

Create new user group

Create new user group

Now you will see that the new user is part of the user group, select Save to finish the process.

User is part of a user group

The user is part of a user group

Edit user

To change user details—such as a user’s email, or contact information—edit the user account.

Select Users under API Management, here you will see all existing user, and you can validate and adjust their permissions and groups.

Select the user you want to edit.

User is part of a user group

The user is part of a user group

This will show you the overview about the user. Now select Edit in the top right corner.

User is part of a user group

Example of an user overview

Adjust the settings and select Save.

Adjust settings

Adjust settings

Delete user

To delete a user.

Select Users under API Management, here you will see all existing user, select the user you want to delete.

Choose the user you want o delete

Choose the user you want to delete

Now select Delete User in the left bottom.

Choose the user you want o delete

Choose the user you want to delete

Confirm the user removal by selecting Yes, delete it.

Choose the user you want o delete

Confirm the user removal

Reset password

Select Users under API Management, here you will see all existing user, select the user where you want to reset the password.

Select Reset password

Copy the link


User groups

Create a group

Select User groups under API Management, here you will see an overview about all user groups.

To create a new user group, select Add User on the right top corner.

User groups

User groups

Delete a group

It is only possible to remove empty groups!

Select User groups under API Management, and select the group you want to delete.

User groups

Choose a user group to delete

User groups

Se

User groups

User groups

Summary

In this tutorial, you learned how to:

  • Add, edit and delete user
  • Create and delete user groups

What's next