The Tenant Management Console is a comprehensive tool that enables system administrators to monitor and manage all aspects of a Managed Service Provider (MSP). The Management Console allows administrators to view all tenant details, add, inactivate or delete tenants, manage other administrators of the MSP, and more.
Roles and Permissions
Every administrator authorized to access the Tenant Management Console can have ONE of the following roles:
- MSP Admin: Can view and manage all tenants within the MSP, and can perform actions related to other users with roles of MSP Admin and MSP Auditor
- MSP Auditor: Has read-only access to information related to the MSP, including tenants and auditing data
The Management Console is accessed using the Octopus Authenticator mobile app, as described in the procedure below. Before attempting to log in, make sure you have downloaded the Octopus mobile app and enrolled your device. (For full instructions, please refer to your enrollment invitation email.)
To access the Management Console:
From your browser, enter the access URL provided for your tenant / enterprise and domain (e.g., https://acme.doubleoctopus.cc/mt).
You are redirected to the Login screen for the relevant tenant.
Enter the email address provided in your enrollment email. Then, click Login.
An authentication request is sent to your mobile device.
From your mobile device, tap Approve.
If you are prompted to provide a verification code, enter the digits displayed on your mobile device.
Following successful authentication, the Tenant Management Console opens.
The main features and components that appear on most pages of the Tenant Management Console are described in the table below the diagram.
Number | Component | Description / Notes |
|---|---|---|
1 | Menu bar | Provides access to the various menus of the Management Console. For more information, refer to Menu Bar. |
2 | Menu title | Name of the currently displayed menu. |
3 | Account options menu | Click the arrow next to your username and select Sign out to end your Management Console session. |
4 | Navigation tools | Enable you to control the number of items displayed on the page (10, 20, 50 or 100) and scroll to other pages of the list. |
Menu Bar
The menu bar enables navigation between the following menus:
Tenants: Presents global statistics and displays information about all tenants (both current and deleted).
Managers: Lists all administrators and provides access to operations for handling them (adding, changing role, etc.).
Audit: Displays a log of every action performed by the system or by administrators.
The Tenants menu displays information about tenants in the system and enables authorized managers to perform administrative actions related to tenants.
.
The main components of this page are described in the table below the diagram.
Number | Component | Description / Notes |
|---|---|---|
1 | Global statistics snapshot | Displays current number of users across all tenants, broken down as follows:
|
2 | Filtering tools | Allow you to filter the Tenants list according to status and/or tenant name (keyword search). For more information about tenant status, refer to Working with the Tenants List. |
3 | Tenants list | Displays general information about each tenant. For details, refer to Working with the Tenants List. |
4 | Deleted Tenants button | Provides access to information about tenants no longer in the system. For details, refer to Viewing Deleted Tenants. |
5 | Create Tenant button | Enables you to add a new tenant. |
The Tenants list provides general data about every tenant, such as user statistics, subdomain and more. The list can be sorted in ascending or descending order according to tenant name, Active / Starter users, or tenant creation date.
Tenant status can be one of the following:
Live (green indicator): The tenant is enrolled, connected and enabled.
Suspended (gray indicator): The tenant is temporarily disabled (Suspending Tenants).
Error (red indicator): The tenant has invalid parameters or connection failures.
Selecting a row in the Tenants list opens the Tenant details page. From this page you can perform the following actions:
Access the Octopus User Portal by clicking the Portal link
Resend an enrollment invitation to the tenant Admin
Access the Octopus Management Console (when the MC SSO Sign in button is available)
To update tenant details, click the Edit button in the upper right corner of the page. The following actions are available in Edit mode:
Change the company (tenant) name
Add and remove tenant administrators (managers)
Enable / Disable the SSO Login toggle
When the toggle is disabled, the the MC SSO Sign in button does not appear on the Tenant details page.
After updating tenant details, click Save.
Suspending and Deleting Tenants
When required, you can perform the following actions on a tenant:
Suspend: Temporarily inactivates the tenant
Delete: Removes the tenant from the Tenants list
To suspend or delete a tenant:
From the Tenants list, open the Tenant details page by selecting the relevant tenant.
At the upper right corner of the page, click Edit to open Editing mode.
The Suspend and Delete buttons appear at the upper right corner of the page.
Perform one of the following flows:
To suspend the tenant, click Suspend. Then, in the confirmation popup, click Yes.
The tenant is inactivated. To reactivate the tenant, follow the procedure above and click Restore.
To delete the tenant, click Delete. Then, in the confirmation popup, type the word DELETE and click Yes.
The tenant is removed and added to the Deleted tenants list.
A list of tenants that have been deleted can be viewed by clicking the Deleted Tenants button in the upper right corner of the Tenants menu.
The Deleted tenants list displays each tenant name and some general information, including deletion date.
To view additional information about a deleted tenant, select the row of the relevant tenant. The Tenant details page that opens is read-only. The data cannot be edited, and no actions can be performed from this page.
The Create Tenant button in the upper right corner of the Tenants menu allows administrators to add new tenants to the MSP.
When the MSP contains the maximum allowed number of tenants, an error message is displayed on attempting to add another tenant.
To add a new tenant:
From the Tenants menu, click Create Tenant.
The Create Tenant page opens.
Enter the organization (tenant) name and subdomain in the appropriate fields.
Then, click Next.
On the Add administrator page, enter the name and email address of the manager to be assigned to the new tenant. Then, click Add Admin.
A confirmation message is displayed. The new tenant is added to the Tenants list, and an enrollment email is sent to the specified administrator.
The Managers menu lists all administrators in the system and displays the name, email address and role of each one.
The filtering tools above the Managers list enable you to filter the list according to manager status and/or manager name or email (keyword search). Manager status can be either of the following:
Active
: The manager has successfully performed the enrollment process.Inactive
: The enrollment process has not begun or is incomplete.
The icons in the Action column of the Managers list allow administrators to perform the following operations on that manager:
Change: Updates the role of the manager. For details, refer to Updating Manager Role (below).
Resend invitation: Sends an additional enrollment email to the manager. To resend an invitation, click
. Then, in the confirmation popup, click Yes.Delete: Removes the manager from the system. To delete the manager, click
. Then, in the confirmation popup, click Yes.
Updating Manager Role
The Change action enables MSP Admins to assign a different role to managers in the MSP.
The Invite Manager button in the upper right corner of the Managers menu allows administrators to add more managers to the MSP.
To add a new manager:
From the Managers menu, click Invite Manager.
The Invite new manager popup opens.
Enter the name and email address of the new manager in the appropriate fields.
NOTE: Every manager in the system must have a unique email address.From the Role dropdown list, select a role for the new manager.
Click Invite.
An enrollment email is sent to the specified email address, and the new manager is added to the Managers list.
The Tenant Management Console records and logs all actions completed or attempted by users and other system components (e.g., servers). You can use these records for troubleshooting, auditing, and fulfilling regulatory requirements.
To view the list of auditing events, select Audit from the menu bar. By default, all recorded events are listed. You can sort the events in ascending or descending chronological order by clicking the Date column header. In addition, you can filter the list according to event severity, timeframe and other factors, as described below (Filtering the Events List).
The icons in the Severity column of the events list indicate the degree of impact (or potential impact) of the event on normal system operation and end user experience. The severity levels are:
Critical: Events that interfere with system functioning, such as failed system setup attempts, invitation enrollment errors, etc.
Warning: Events that interfere with management and administrative operations (e.g., unsuccessful Admin login to the Management Console).
Info: Events involving routine flows, actions and operations.
To download auditing events in CSV format, click Generate CSV (at the upper right corner of the page). When auditing filters are selected, the filtered events list is downloaded.
The filtering options above the events list enable you to filter displayed events according to severity, timeframe, action type, and/or a specific search term, such as a subdomain. Multiple filtering methods can be used simultaneously.
To return to the default view, click Reset Filter.
The filtering options are:
Severity: Select the relevant level(s) from the list.
Date: Select the relevant option, or choose Select date range and specify start and end dates in the calendar popup.
Tenant / Subdomain / User: Enter all or part of the name(s) in the relevant field(s).
Action: Select the relevant options(s) from the list.
The following example shows events filtered according to severity, timeframe and username:
