Invite Users

You can invite new users to the Master organization. The process for inviting and adding users is the same for Internal and API partner organizations.

When inviting new users, they are sent an automated invitation email with a one-time invite link. Once a user accepts the invitation, then you can add them to other organizations.

Invite new users

You can add users to your organization. There are three types of organizations where you can add users. The process of adding new users is the same for all organizations. It's important to know that the invite link can only be used once.

When inviting a user, two emails are sent to the user.

1. Invite email: The user receives a one-time invite link to create a username and password. You can resend the invite link if needed.
2. Activation email: The user receives an email to log in to the platform and activate their account.

Add existing users

You can only add an existing user to the Master and Internal Organizations as the API Partner Organization is an external entity; it can only have new users. To add existing users in the Master or Internal Organization, follow the below steps:

• First, click the Edit label for the organization you want to add an existing user.

• This will open the Organization's Users tab.
• Here, click the Add Existing User button.

• A popup will appear; enter the user's email and select it once found.
• Then, click the Add button.

And you'll get a successful notification.

Tip

To add multiple existing users at once, enter their email addresses with a comma as the separator.

Change role

The Master and Internal Organizations can have five different user roles. However, the Internal Organization has Owner as the role type instead of platform-admin compared to the Master Organization. In the API Partner Organization, you can only have three user roles. To learn more about the user roles, refer to the Types of User Roles Table above.

To change a user's role, do the following.

• In your Organizations section, click on the Edit label of the organization where you need to change the role.
• The organization's Users tab will open.
• There, search for the user in the search bar or the table.
• Once you have found the user, go to the Role column and click the drop-down menu.

• Then, select the role you need to assign from the available user roles.

User roles available for the Master Organization

User roles available for the Internal Organization

User roles available for the API Partner Organization

Change user status

While using the API Manager or Admin Console, some users might not need access to particular organizations, whether Master, Internal, or API Partner Organizations. Therefore, in that case, you want to restrict their access temporarily or permanently. To do that:

• In your Organizations section, click on the Edit label of the organization where you need to change the user status.
• The organization's Users tab will open.
• There, search for the user in the search bar or the table.
• Once you have found the user, go to the Status column and turn the toggle from active to inactive.

• Then, select Disable in the Popup.

This will revoke the user's access to the particular organization. If you need to lift the ban, turn the toggle from inactive to active, and in the popup, select Activate.

Delete a user

In order to delete a user from a particular organization, follow the below steps.

• In your Organizations section, click on the Edit label of the organization where you need to change the user status.
• The organization's Users tab will open.
• There, search for the user in the search bar or the table.
• Once you have found the user, go to the Delete column and click the delete icon.

This will open a popup asking you to confirm your deletion. The popup is different for each organization.

In the case of Marster Organization, you need to migrate the APIs associated with the user to another user of the same organization. This is required because it will delete the master organization user completely from the system. Once you click Delete, the user's complete profile and all its relations (subscriptions, applications) will be removed from the system. Hence, you must migrate the APIs first and then delete the user. To do so:

• First, enter the user's email to whom you want to migrate in the Migrate To field.
• Then, confirm the email of the user you need to delete.
• After adding the details, click Delete.

In the case of Internal Organization, click Delete in the popup.

Info

In the Internal Organization, you cannot delete a user with an Owner-role assigned. Also, the user will be mapped to Master Organization with the default role as api-consumer. If the user is already present in Master, then its role will be given preference.

In the case of API Partner Organization, click Delete in the popup.

Info

In the API Partner Organization, you cannot delete a user with an Owner-role assigned.

Once you click the Delete button, the user will be deleted from the Organization and cannot access it permanently.