Administering user accounts

Only Administrator users can perform user administration tasks. These are:

  • Managing domains
  • Managing users
  • Managing API clients

Managing Domains

A “domain” implies a corporate email domain. Most organizations have one unique domain, but others may have different domains for sub-organizations.

Note

You must add a domain before you can add any users. The primary domain for your organization will be created during the Hyperview onboarding process.

You can add a new domain as follows:

  1. In the user management portal, click Domains under User Administration.
  2. Click Add Domain.
  3. Enter a valid corporate domain. The page will refresh showing a confirmation message and the newly added domain.

To remove a domain, simply click the corresponding Remove button from the list of domains. A confirmation message will appear upon deletion.

Managing users

You can add, edit, lock or delete user accounts.

To add a user:

  1. In the user management portal, under User Administration click Users > Add User.
  2. Enter user details as follows:
  1. Provide the First Name and Last Name.
  2. Provide the Email value (you will need to select a pre-existing domain from the dropdown).
  3. Provide a Password and then an identical Confirm Password value (must be 6-100 characters and have at least one of the following: uppercase letter, lowercase letter, digit, symbol).
  4. Assigning a Role as appropriate (refer to the “User roles” section in Introduction).

Warning

You cannot update a user’s email address after the account has been created. You can only update the password for your own account (from the Password link under My Account).

  1. Click Add. The page will refresh showing a confirmation message and the newly added user.

adduser

To edit an existing user, click the Edit button for the intended user and follow the aforementioned steps.

To lock an existing user, click the Lock button for the intended user. To unlock a locked user, click Unlock.

To delete an existing user, click the Delete button for the intended user, then Delete again. A confirmation message will appear and the user will no longer be listed.

Managing API clients

You can create user accounts for API clients, which let you programmatically integrate with Hyperview’s RESTful APIs.

To add an API client user:

  1. In the user management portal, under User Administration click API Clients > Add API Client.
  2. Provide values for Description, Role, and Access Policies. If you are unsure of which access policy to use for the API client, select Default.
  3. Click Add and Download Credentials. A “client_credential.json” will be downloaded to your browser’s default download location. A confirmation message will appear in Hyperview, and the API client will be listed.

addapiuser

Warning

Please treat your API client credentials as you would for a human user, and store it in a safe place. The Client ID and Secret values cannot be modified after the API client has been created. If you have previously downloaded the client credentials file, an incremental digit will automatically get appended to the filename (such as “client_credential (2).json” in Google Chrome).

To delete an API client user, click the Delete button on the intended row. A confirmation message will appear.