Manage Users

This article describes how Portal Admins and Org Admins add and edit user account information.
This article describes how Portal Admins and Org Admins add and edit user account information.
Add Users
Portal Admins and Org Admins can add other users to
API Portal
. Portal Admins can add users and can assign a role to them. Org Admins can add Developers and other Org Admins to their organization.
Portal Admins can add users only if single sign-on (SSO) is disabled.
If Third-Party Registration is enabled, anonymous users can register themselves and their organization.
API Portal
automatically assigns these users the Org Admin role. Users cannot add themselves to an existing organization.
If the Registration Request Workflow for Third-Party Registration is also enabled:
  1. The user completes the registration form.
  2. The Portal Admin approves the registration request.
  3. The user can complete the account setup form.
Account plans are associated with organizations.
Prerequisite:
The organizations have been added.
Follow these steps:
  1. Log in to
    API Portal
    as a
    Portal Admin
    or
    Org Admin
    .
  2. From the menu bar, select the gear icon,
    Users
    .
    The
    Users
    page opens.
  3. Select
    Add User
    .
    The
    Add User
    page opens.
  4. In the
    User Type
    section, select the user type:
    • To add a Portal Admin or API Owner, select
      Global Publishers
      .
    • To add an Org Publisher, Org Admin, or Developer, select
      Org Users
      .
  5. Add the user details.
  6. (For Global Publishers only) Select the role that is applicable to this user, either
    Admin
    or
    API Owner
    .
    (For Org Users only) Click
    Next
    to proceed to selecting one or more organizations and assigning a corresponding role to the user.
    You must assign the user to at least one organization before you can save the user details.
  7. Select
    Create
    .
  8. If you left the
    Notify User
    checkbox selected on the Add User page,
    API Portal
    sends an account activation invitation to the user by email. The Users page shows that the user account is pending activation, whether the invitation was sent or not.
    If you cleared the
    Notify User
    checkbox, then later when you want to send the invitation to the user, complete the following:
    1. Go to the
      Users
      page.
    2. On the
      Actions
      menu column for that user, select
      Resend Activation Email
      .
The user account is active after the user accepts the invitation and completes the account setup form.
Search for a User by Name and Email
Consider the following points:
  • Search by first name, last name, or full name (Format: First name Last name).
  • The
    Name
    and
    Email
    fields are self-predictive fields, which means that when you enter at least three consecutive characters, the system fetches the matching records. For example, if you are searching for Robert, then entering "Rob" or "ber" in the Name field shows you the names of all the users containing the search string. This search is case insensitive.
  • Wildcard characters are not allowed in the search string. If entered, these are treated as normal characters.
  • For email search, the special characters
    !#$%&*+/=?^[email protected]`{|}~-
    are allowed.
Edit User Account Information
You can edit user accounts using the Edit User page. The following rules are applicable:
  • You cannot edit your own account.
  • (For Publishers only) You cannot edit user details of an external IdP user.
  • Portal Admins can:
    • Edit the users who are managed in
      API Portal
      . You can map only Developers to multiple organizations and roles.
    • Edit the organization and role of Developers (IdP users) who are authorized using
      API Portal
      .
    Portal Admins can manage users using
    API Portal
    only if single sign-on (SSO) is disabled.
  • The Org Admin can only edit the users who are created and managed in
    API Portal
    . The user must belong to same organization as the Org Admin.
You can edit the following account information of a user, added and managed from
API Portal
:
  • Names (but not the username)
  • Email address
  • Language (but this setting has no effect)
  • (For Publishers only) Role (only to another role in the same role category)
  • State (enabled or disabled)
  • (For Developers only) Organization and role (map with multiple organizations and corresponding roles)
You can edit the following account information of an external IdP with the authorization type as "Portal":
  • Organization and role (map with multiple organizations and corresponding roles)
Follow these steps to edit a user added and managed in
API Portal
:
  1. Log in to the
    API Portal
    as a Portal Admin.
  2. From the menu bar, select the gear icon,
    Users
    .
  3. Click on the user name to edit the user details.
    The
    User Details
    page appears.
  4. Edit the user information.
  5. (For Developers only) Select
    Next
    . Select one or more organizations and a corresponding role to assign to this user.
    You cannot save the user details without assigning the user to at least one organization.
  6. Select
    Save
    .
(Developers only) Follow these steps to edit a user using external authentication scheme to log in to
API Portal
:
To edit an external IdP user from
API Portal
, you must edit the authentication scheme of this user to change the authorization type to "Portal". But after editing the authentication scheme, all new
Publishers
of this authentication scheme are unable to log in to
API Portal
. To address this limitation, create an authentication scheme for all the new Publishers. This does not impact the users who have previously logged in to
API Portal
.
  1. While logged in to the
    API Portal
    as a Portal Admin, edit the authentication scheme that the user uses:
    1. From the menu bar, select the gear icon,
      Authentication
      .
    2. Select
      Edit
      from the
      Actions
      menu of the authentication scheme.
    3. Go to the
      Attribute Mapping
      section, select
      Portal
      from
      Select Authorization Type
      , and then save the authentication scheme.
  2. Map the user to multiple organizations:
    1. Select
      Users
      .
    2. Go to the
      Developers
      tab.
    3. Click on the user name to edit the user details.
      The user details are displayed. This page is read-only.
    4. Select
      Next
      .
    5. From the
      Select Organization and Role
      page, select the organization and the corresponding role, and then select
      Save
      to save the mapping.
      The user is mapped to one or more organizations.
Enable and Disable User Accounts
You can enable and disable user accounts. You cannot enable or disable your own account.
Follow these steps:
  1. Log in to the
    API Portal
    as a Portal Admin or Org Admin.
  2. From the menu bar, select the gear icon,
    Users
    .
  3. In the
    Actions
    menu for the user, select
    Edit
    .
  4. Change the state to Enabled or Disabled, and then select
    Save
    .