General

Last updated on June 19, 2024

This tab enables you to customize an Instance's general information, such as its name and thumbnail. It also allows you to switch the Instance into maintenance mode and provides a way to update its Console SSO Key. It is divided into the following sections:

  • General Settings
  • Maintenance Mode
  • Console SSO Key

General Settings

You can use this section to customize an Instance's general information, such as its name, tags, and thumbnail. The field descriptions are as follows:

Input LabelTypeRequiredDescription
Name Text Field No The name of your Instance.
UUID Display Field No The Instance's UUID. This is an uneditable system field.
Tags Text Field No The tags associated with your Instance.
Thumbnail Clickable Field No The Instance thumbnail image.

Maintenance Mode

Enabling maintenance mode temporarily prevents end users from interacting with the application to enable administrators and developers to perform maintenance tasks, updates, or fixes. Users, in turn, are directed to a customizable splash page during maintenance, providing information about the ongoing maintenance process. The customization of this splash page is facilitated through the Instance Admin (IIA).

Using maintenance mode can help prevent data corruption, promote safe updates and deployments, and ensure system stability. You can switch an Instance to maintenance mode using the following input:

Input LabelTypeRequiredDescription
Maintenance Mode Toggle No Enables or disables maintenance mode.

Console SSO Key

This section allows you to regenerate and copy the Console SSO Key of the Instance. This key acts as an authentication mechanism, validating a user's identity and granting access to the Instance from the Console without requiring separate login credentials for the Instance.

Input LabelTypeRequiredDescription
Console SSO Key Display Field No The Console SSO Key of the Instance.

Regenerating an SSO Key

You may need to regenerate the Console SSO Key of an Instance as a security measure if, for example, a breach or security compromise is detected in your system. Additionally, regenerating the Console SSO Key of an Instance can be incorporated as a standard operating procedure during employee turnovers or implemented periodically as a best practice to enhance overall security.

To regenerate the Console SSO Key of an Instance:

  1. Navigate to Instances from the main menu.
  2. Find the Instance whose Console SSO Key you want to regenerate on the main page or inside one of the folders.
  3. Select 'Edit Instance' .
  4. Select REGENERATE SSO KEY.
Have a suggestion for this page?

Didn't quite find what you are looking for or have feedback on how we can make the content better then we would love to hear from you. Please provide us feedback and we will get back to you shortly.