Skip to Content

User Management

Introduction

The User Management page of the Management Console allows Harmony organization administrators (members of a role with the Admin organization permission) to invite external users and define their access to individual APIs or API groups.

To access the User Management page, log in to the Harmony Portal, then use the Harmony Portal menu in the top left to navigate to Management Console > User Management:

harmony portal menu user management

Add an External User

To add an external user, click Add External User or click the add icon add icon in the top right of the screen:

add user

When you add an external user, these configuration options become available to configure in the first row of the External Users Table:

add user configuration

  • Email: Enter the email address of the external user. The email address cannot be associated with a Harmony organization member.

  • Access To: This field is set to APIM (API Manager Portal) and cannot be changed.

  • Access Expires: Use the toggle to show (Set Date) or hide (Never) a calendar datepicker that can be used to set a date for access to expire. Access expires at 11:59 pm on the selected day using the external user's local machine's time zone.

  • Submit: Click the submit icon submit icon to send a registration email to the external user. The registration email provides a link to register as an API Manager Portal user. The external user provides their name and company and sets a password.

  • Cancel: Click the cancel icon cancel icon to close the configuration without saving.

External Users Table

Each row in the External Users table displays external users with access to the API Manager Portal page within the organization:

external users table

  • Email: The email address of the external user.

  • Name: The name of the external user as provided by the user during registration.

  • Company: The company of the external user as provided by the user during registration.

  • Status: The status of the external user, either Requested, Active, or Suspended:

    • Requested: Indicates that a registration invitation has been sent to the external user, and they have not yet registered.

    • Active: When toggled to Active, the external user has access to their assigned APIs or API groups and the API Manager Portal page. By default, all registered external users are toggled to Active.

    • Suspended: When toggled to Suspended, the external user's access to their assigned APIs or API groups and the API Manager Portal page is revoked immediately.

  • Access To: Clicking API Portal opens a configuration screen to view or select the API groups or APIs the external user has access to:

    • API Groups: Select one or more API groups to grant the external user access to. All API groups for the organization are displayed. You can use the API groups search box to search for API groups by name.

    • APIs: Select one or more APIs to grant the external user access to. All APIs for the organization are displayed. You can use the API search box to search for APIs by name.

  • Access Expires: The date the external user's access will expire. Access expires at 11:59 pm on the selected day using the external user's local machine's time zone.

  • Last Login: The date of the external user's last login.

  • Member Since: The date the external user registered their account.

  • Actions: These actions are available when hovering over the Actions column:

    • Resend: Visible only when a user's Status is Requested. Click the resend icon resend icon to resend the registration invitation.

    • Edit: Visible only for registered external users. Click the edit icon edit icon to edit the access expiration for registered non-expired external users.

    • Delete: Click the delete icon delete icon to delete the external user and revoke their access to the APIs or API groups and the API Manager Portal page.