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 administrators and Organization administrators can add other users to API Portal:
  • Portal administrators can add users and can assign a role to them.
    If single sign-on (SSO) is enabled, then Portal administrators cannot add users using
    API Portal
    .
  • Organization administrators can add Developers and other Organization administrators to their organization.
If third-party registration is enabled, anonymous Developers can add themselves and their developer organization. API Portal automatically assigns them the Organization administrator role. Developers cannot add themselves to an existing developer organization.
If the registration request workflow is also enabled:
  1. The Developer completes the user registration form.
  2. The Portal administrator approves the registration.
  3. The Developer can complete the account setup form.
Account plans are associated with developer organizations.
Prerequisites:
Before adding a Developer or Organization administrator to API Portal, the Portal administrator must add their developer organizations.
Follow these steps:
  1. Log in to API Portal as an
    admin
    or
    Org Admin
    .
  2. Select
    Administration
    .
    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 an administrator or API owner, select
      Admin & API Owners
      .
    • To add an Organization publisher, Organization administrator, or Developer, select
      Org-based User
      .
  5. Add the user details.
  6. (For Admin & API owners only) Select the role that is applicable to this user, either Admin or API Owner.
    (For Org-based Users only) Select
    Next
    , and then select one or more organizations and a corresponding role to assign to this org-based user.
    The user must be assigned 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:
    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 User by Name and Email
Consider the following points:
  • Search by first name, last name, or full name (Format: First name Last name).
  • Name and Email are self predictive fields, which means entering at least three consecutive characters fetches you 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. The same logic also applies to Email field.
  • 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 administrators 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.
    If single sign-on (SSO) is enabled, then Portal administrators cannot manage users using
    API Portal
    .
  • The Organization administrator can only edit the users who are created and managed in API Portal. The user must belong to same organization as the Organization administrator.
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 an administrator.
  2. Select
    Administration
    .
  3. In the
    Actions
    menu for the user, select
    Edit
    .
  4. Edit the user information from the
    User Details
    page.
  5. (For Developers only) Select
    Next
    . Select one or more organizations and 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. Log in to the
    API Portal
    as an administrator.
  2. Edit the authentication scheme that is used by the user:
    1. Select
      Administration
      ,
      Authentication
      .
    2. Select
      Edit
      from the
      Actions
      menu of the authentication scheme.
    3. Go to
      Attribute Mapping
      section, and then select
      Portal
      from
      Select Authorization Type.
    4. Save the authentication scheme.
  3. Map user to multiple organizations:
    1. Select
      Users.
    2. Go to
      Developers
      tab.
    3. In the
      Actions
      menu for the user, select
      Edit
      .
      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.
    6. 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 an administrator or Organization administrator.
  2. Select
    Administration
    .
  3. On the
    Actions
    menu next to the user, select
    Edit
    .
  4. Change the state to enabled or disabled.
  5. Select
    Save
    .
More Information: