Portal Administration: Organization, Users, Licences, and API Keys

Portal Admins are roles within an organization that can administer the organization, add/edit/remove users, distribute extension licences, and control API Keys. Portal Admins can access all administrative settings and actions through the Settings button on the Exchange.ai Portal Toolbar. 

On the Settings page, the Portal Admin will see the Admin Setting Panel in addition to the Portal Admin's user Settings. All actions and controls the Portal Admin has access to reside here. 


The Organization Panel allows the Portal Admin to edit organization-level information.

Option Description
Name, Description Name and Description of the organization.
Drop-down of industries. Select the Industry that best describes the organization.
Domain Domain of the organization. This domain must match match the domain of user's emails (e.g. ruths.ai in info@ruths.ai).

Portal Admins can allow uses to register themselves with an email address that matches this domain--by default this is enabled to allow users to register themselves. If unchecked, this will force users to register via, Azure Active Directory only.
Replace, Add Image
When replacing or adding profile or background images, the user is presented with the Add Image modal. After adding an image by dragging or pasting, confirm the upload with the Upload Image button.

NOTE: Profile and Background Images are optional.
Save Saves all edits and image uploads.

NOTE: Images will not save if the user does not Save the edits.


The Add User and Manage Current User Panel allows the Portal Admin to administer the organization's Users.

Option Description
Add User
 Add a new User to the organization. This action will send a registration email to the user. To add Azure Active Directory users simply have the user sign into the Portal with their Microsoft Account--a new account will created for them automatically. NOTE: If a user has an existing password account and they sign in with their Microsoft account their accounts will be merged and they will be forced to login via their Microsoft account moving forward.
Manage Current Users Table Each User in the organization is displayed here. The exposed fields can be sorted. There are various actions the Portal Admin can take within the Manage Current Users Table.
Last Name, First Name, Email Basic User profile data.
Roles Identifies the current Roles a User is assigned.
Account Type Identifies sign-on method.
password User has registered with email and password directly with the Exchange.ai Portal. If a User has a password Account Type, the User can then also have an azureAD Account Type.
azureAD User has logged on with Microsoft. Users with azureAD Account Types will only be able to login with this method.

Actions Various actions for the Portal Admin.
Edit Edit aspects of the User's profile including Roles. Discussed below.
Remove Remove the User from the organization.
Reset Reset the password for a User.

NOTE: Resetting passwords are only available to Users with the password Account Type.
The Edit Action will expand the Manage Current Users Panel to allow for edits. 

Email, First Name, Last Name, Position, Description Edit basic User profile data in these free text fields. Editing the email will cause the user to verify the new email address.
User Roles Check which Roles to apply to the user. No checks will apply the basic User Role to the user.
Save Save the edits.
Cancel Cancels all edits.


The Licenses Panel allows the Portal Admin to retrieve extension license keys for the onsite Spotfire Admin. These Licence Keys are then added to Spotfire's Preference Manager and distributed to Spotfire users.

API Keys

The Exchange.ai Portal API Keys Panel allows the Portal Admin to create and retrieve Portal API Keys. The Exchange.ai Portal API allows programmatic access to the organization's data on the Exchange.ai Portal.

Option Description
+ Generate App ID and API Key Click to create a new App ID and API Key. Securely store the API Key. This is the only time that the API Key can be viewed. It cannot be recovered later. However, Portal Admins can create a new App ID and API Key at any time.

App ID Table Each App ID in the organization is displayed here. The exposed fields can be sorted. There are various actions the Portal Admin can take within the App ID Table.
Edit Allows the Portal Admin to Edit the Description of the App ID as well as Enable/Disable the App ID.

Enable/Disable Quick access to the Enable/Disable action.
Delete Permanently Delete the App ID.