Itential Cloud Portal
  • Dark
    Light
  • PDF

Itential Cloud Portal

  • Dark
    Light
  • PDF

Immediately after logging into your Itential Cloud account, you will be redirected to Itential Cloud Portal, a web-based user interface (UI) from which you can access and manage all aspects of your organization's Itential Cloud environment. Common use cases for Itential Cloud Portal include:

  • Creating, launching, and modifying cloud-based Itential Automation Platform (IAP) instances.
  • Performing administrative actions that affect your organization's entire Itential Cloud environment.
  • Managing your Itential Cloud account.

This page documents the features of Itential Cloud Portal and provides guidance on their effective use.

Itential Cloud Portal User Interface

The main elements of the Itential Cloud Portal UI are referenced in Figure 1.

Label UI Element Function
1 Sidebar Displays icons used for navigation between pages in Itential Cloud Portal. The Instances page is selected by default.
2 Page Content Displays the content of the current page.
3 Menu Button Displays links to account management actions and user support resources.


Note:

The Sidebar also displays a link used to download Itential Automation Gateway (IAG).


Figure 1: Itential Cloud Portal UI

itentialCloudPortalUI


Usage details for these UI elements are provided in the following sections.

Instances

The homepage of Itential Cloud Portal, Instances, provides a unified interface for all instance-related actions and management in Itential Cloud.

Instances Table

The UI of the Instances page is largely composed of the Instances Table. The Instances Table provides a searchable and sortable view of your organization's cloud-based IAP instances, from which you can:

  • Create or delete instances.
  • Launch or restart instances.
  • Modify instances.

The main elements of the Instances Table are referenced in Figure 2.

Label UI Element Function
1 Toolbar Icons used to perform Instances Table management actions. From left to right, these are: Refresh the display of IAP instances and Create a new IAP instance.
2 Search Bar Used to search and filter instances by Name, Id, or Env.
3 Table Body Displays instances matching any specified search filter in table format.
4 Pagination Controls Sets how many table rows to show per page and shows the total number of discrete pages. Use the left and right arrows to move between pages.


Figure 2: Instances Table

intentialCloudPortalInstancesTable

Fields in the Instances Table

Each row in the Instances Table corresponds to an instance of IAP, while each column provides information about that instance or user actions that can be taken against that instance. Each table column, or field, is referenced below.

Table Field Description
Status The current status of the instance. Valid states are Online (✔), Offline (X), and Initializing (!).
Name The name of the instance. Click the instance name to modify the instance.
Id The automatically generated identity of the instance. Click the Id number to modify the instance.
Launch Click the icon button to launch the UI of the instance in a new web browser tab.
Env The environment (Env) assigned to the instance at instance creation.
Version The IAP version of the instance.
Type The classification of the instance. Currently, a standard type is assigned when a new instance is created.
Uptime The amount of time the instance has been online.
Cluster The high availability cluster the instance is running in.
Created The date and time the instance was created.
Expiration The date and time at which the instance will expire.


Creating an Instance

To create an instance from the Instances page:

  1. Click the Create a new IAP instance (+) icon from the Instances Table toolbar; the Create an Instance of IAP modal appears.
  2. Select an environment (a logical grouping of IAP instances) to assign the new IAP instance to from the Environment drop-down menu.
  3. Enter a name for the IAP instance in the Name field.
  4. Click the Create button at the bottom-left corner of the modal.

Immediately after being created, the new instance will display a status of Initializing (!). When the instance is ready to be launched, its status will change to Online (✔).

Launching an Instance

To launch an instance from the Instances page:

  1. Locate the desired instance in the Instances Table.
    • If you know the name or Id of the instance, or the environment that the instance is assigned to, you can apply it as a filter using the Search Bar.
    • You can sort the Instances Table by any field (excluding Launch) in ascending or descending order by selecting the relevant column header.
  2. Click the Launch itentialCloudPortalLaunchIcon icon from the Launch field of the desired instance; the UI of the instance will open in a new web browser tab.

Modifying an Instance

Some properties of existing instances can be modified through the Modify Instance window. From this window, you can:

  • Launch the instance.
  • Restart the instance.
  • Delete the instance.

To access the Modify Instance window:

  1. Locate the desired instance in the Instances Table.
    • If you know the name or Id of the instance, or the environment that the instance is assigned to, you can apply it as a filter using the Search Bar.
    • You can sort the Instances Table by any field (excluding Launch) in ascending or descending order by selecting the relevant column header.
  2. Click the Name or Id field of the desired instance to open the Modify Instance window.

The main elements of the Modify Instance window are referenced in Figure 3.

Label UI Element Function
1 Toolbar Icons used to perform instance management actions. From left to right, these are: Launch, Restart, and Delete.
2 Instance Details Displays details of the current instance.


Figure 3: Modify Instance

itentialCloudPortalModifyInstance

Restarting an Instance

To restart an instance from the Modify Instance window:

  1. Click the Restart itentialCloudRestartIcon icon from the toolbar; a confirmation modal will appear.
  2. Click the Restart button at the bottom-left corner of the modal. A success bannner displays when the restart process has been successfully initiated for the instance.

Deleting an Instance

To delete an instance from the Modify Instance window:

  1. Click the Delete itentialCloudPortalDeleteIcon icon from the toolbar; a confirmation modal will appear.
  2. Enter the the text indicated by the modal into the entry field.
  3. Click the Delete Instance button at the bottom-left corner of the modal.

Member Administration

Administrative activities related to Itential Cloud accounts associated with your organization are performed via the Members Administration page. The UI of the Members page is largely composed of the Members Table. The Members Table provides a searchable and sortable view of all Itential Cloud accounts associated with your organization, from which you can:

  • Create new Itential Cloud accounts.
  • Edit Itential Cloud account settings.
  • Delete Itential Cloud accounts.

The main elements of the Members Table are referenced in Figure 4.

Label UI Element Function
1 + New Creates a new Itential Cloud account.
2 Search Bar Searches Itential Cloud accounts by username, first and last name, or e-mail address.
3 Pagination Controls Sets how many table rows to show per page and shows the total number of discrete pages. Use the left and right arrows to move between pages.
4 Table Body Displays Itential Cloud accounts matching any specified search filter.


Figure 4: Members Table

itentialCloudPortalMembersTable

Fields in the Members Table

Each row in the Members Table corresponds to an Itential Cloud account, while each column provides information about the account or actions that can be taken against that account. The following table describes each table column, or field, shown in the Members Table.

Table Field Description
Username The username associated with the account.
Name The first and last name of the user associated with the account.
Email The e-mail address associated with the account.
Verified The verification status of the account.


Adding Accounts to Itential Cloud

To add a new user account to Itential Cloud from the Members page:

  1. Click the + New button; the Create a New Member modal will appear.
  2. Enter the user's first name, last name, and e-mail address into the relevant fields.
  3. Click the Create button at the bottom-left corner of the modal.

Editing Account Settings

To edit the settings of an existing Itential Cloud account from the Members page:

  1. Locate the desired account in the Members Table.
    • If you know the username, name, or e-mail address of the account, you can apply it as a filter using the Search Bar.
    • You can sort accounts by any field (excluding Verified) in ascending or descending order by selecting the relevant column header.
  2. Click the row of the desired account in the Members Table; the Account Settings window will display for that account (Figure 5).

Specific actions that can be taken from the Account Settings window are described below.

Figure 5: Account Settings

itentialCloudAccountSettings


Assigning Account Groups

To assign an Itential Cloud account to a group from the Account Settings window:

  1. Select the checkbox of the desired group from the list displayed in the Groups section.
  2. Click the Save button at the top-left corner of the window.
Note:

For more information about groups, refer to the Group Administration section of this document.

Resetting Account Passwords

To reset the password of an Itential Cloud account from the Account Settings window:

  1. Click the Other Actions button at the top of the window; a dropdown menu will appear.
  2. Select Reset Password from the dropdown menu. An e-mail containing a link to reset the account password will be sent to the e-mail address associated with the account.

Deleting Accounts

To delete an Itential Cloud account from the Account Settings window:

  1. Click the Other Actions button at the top of the window; a dropdown menu will appear.
  2. Select Delete User from the dropdown menu. A confirmation modal will appear; select the Delete button at the bottom-left corner of the modal.
Note:

Itential Cloud accounts can also be deleted from the Members Table UI by clicking the Delete itentialCloudPortalDeleteIcon icon at the far-right of the relevant table row.

Group Administration

Permissions are granted to Itential Cloud user accounts via membership in groups. A group is a collection of roles in which each role corresponds to a permission. When an Itential Cloud user account is added to a group, it inherits any permissions granted by the roles assigned to that group.

Administrative activities related to groups are performed via the Groups Administration page. The UI of the Groups page is largely composed of the Groups Table. The Groups Table provides a searchable and sortable view of all groups associated with your organization, from which you can:

  • Create new groups.
  • Edit the settings of existing groups.
  • Delete groups.

The main elements of the Groups Table are referenced in Figure 6.

Label UI Element Function
1 Create Group Creates a new group.
2 Search Bars Searches the corresponding table column.
3 Table Body Displays groups matching any filter specified in the Search Bars.
4 Pagination Controls Sets how many table rows to show per page and shows the total number of discrete pages. Use the left and right arrows to move between pages.


Figure 6: Groups Table

itentialCloudPortalGroupsTable

Fields in the Groups Table

Each row in the Groups Table corresponds to a group, while each column provides information about that group. Each table column, or field, is referenced below.

Table Field Description
Name The name of the group.
Path The fully qualified path of the group.
Members The number of members in the group.


Default Groups

By default, the membership groups in Itential Cloud are admins and users.

Group Description
admins Allows members to edit high-level organization information and perform administrative actions related to IAP instances, users, and groups.
users Allows members to launch assigned IAP instances and view information such as existing IAP instances, users, and groups.


Creating a Group

To create a group from the Groups page:

  1. Click the Create Group (+) button at the top-left corner of the Groups table to open the Create New Group modal.
  2. Enter a name for the group into the Name field.
  3. Click the Create button at the bottom-left corner of the modal.

Editing a Group

To edit an existing group from the Groups page:

  1. Locate the desired group in the Groups Table.
    • If you know the name, path, or members value of the group, you can apply it as a filter using the Search Bars.
    • You can sort groups by any field in ascending or descending order by selecting the relevant column header.
  2. Click the row of the desired group in the Groups Table; the Group Settings window will display for that group (Figure 7).

Specific actions that can be taken from the Group Settings window are described below.

Figure 7: Group Settings

itentialCloudGroupSettings


Assigning Roles to a Group

Two collections of roles are available to be assigned to a group: Cloud API and IAP.

Role Collection Description
Cloud API Contains roles that grant permissions to functions of the Itential Cloud Portal UI and API.
IAP Contains roles that grant permissions to a specific instance of IAP.


To assign roles to a group from the Group Settings window:

  1. Select the tab of the desired role collection in the Roles section of the window to view all roles in that collection.
    • When viewing the IAP collection, you must select which instance of IAP you are assigning roles for before the collection will be displayed.
  2. Select the checkbox of the desired roles.
  3. Click the Save button at the top-left of the window.

Assigning Members to a Group

To assign members to a group from the Group Settings window:

  1. Select the checkbox of the desired user accounts from the list displayed on the right-hand side of the window.
    • If you know the username of the desired account, you can apply it as a filter using the search bar at the top of the list.
  2. Click the Update Members button located directly above the list.

Deleting a Group

To delete a group from the Groups page:

  1. Locate the desired group in the Groups Table.
    • If you know the name, path, or members value of the group, you can apply it as a filter using the Search Bars.
    • You can sort groups by any field in ascending or descending order by selecting the relevant column header.
  2. Click the Delete itentialCloudPortalDeleteIcon icon at the far-right of the relevant table row.

Managing Your Account

You can perform several management actions for the currently signed-in Itential Cloud account from the My Account page of Itential Cloud Portal.

To access the My Account UI:

  1. Click the menu button at the upper-right corner of the Itential Cloud Portal UI; a menu will appear.
  2. Select My Account from the menu; you will be redirected to the My Account page.

My Account User Interface

The My Account UI is separated into two cards: Profile and Tokens (Figure 8).

Card Description
Profile Allows you to manage information related to your account such as name and password.
Tokens Allows you to manage the tokens you use to authenticate to Itential Cloud APIs.
Caution:

⚠ The Itential Cloud APIs are currently undocumented; therefore, they are not recommended for customer use.

Figure 8: My Account

itentialCloudPortalMyAccount


Changing Your Name and Email

To change the name or email associated with your account from the Profile card:

  1. Enter a new value using the relevant text input fields (First Name, Last Name, Email).
  2. Click Save to retain your changes.

Resetting Your Password

To reset the password for your account, click Reset Password from the Additional Actions section of the Profile card. An e-mail containing a link to reset your account password will be sent to the e-mail address associated with your account.

Copying and Refreshing Access Tokens

To copy your access tokens, click the Copy to Clipboard itentialCloudCopyToClipboardIcon icon in the relevant Cloud UI or Cloud API section of the Tokens card. Likewise, to refresh your access tokens, click the Refresh (↻) icon in the relevant Cloud UI or Cloud API section of the Tokens card.

Getting Help & Support

Several links to support resources, such as user guides and training courses, are provided via the menu button at the upper-right corner of the Itential Cloud Portal UI. Upon selecting a link from the menu, you will be redirected to the relevant content in a new web browser tab.


Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.