RapidIdentity Product Guide: Legacy UI

RapidIdentity

The RapidIdentity Interface provides 7 additional interfaces:

RI_Appliance_Config_Screen.png
Status

The RapidIdentity Status interface provides the option to Stop, Start, or Restart RapidIdentity at the process level. 

Appliance_Status.png

The Restart option can be used after making changes to configuration options in the CLI or through the RapidIdentity Appliance Home page.

The Stop option is helpful when making changes that affect RapidIdentity globally, such as an uninstall-reinstall of the Local Database or LDAP Server.

The Start option is helpful in the event the service was stopped.

Main Database

The Main Database menu item lists the currently configured database. Selecting this option opens a submenu with 7 additional items.

  1. Type

  2. Host

  3. Port

  4. Database/Schema

  5. Username

  6. Password

  7. Advanced

Main_Database_1.png

Selecting options 2-6 opens a prompt for administrators to change the values for each of those fields. The Advanced menu item directs to the rapididentity.properties configuration file.rapididentity.properties

Selecting the Type menu option allows administrators to change the main RapidIdentity Database. The currently supported databases types are MySQL, PostgreSQL, and MSSQL.  

Main_Database_2.png

If the Main Database is changed, it is necessary to Restart RapidIdentity for the change to take effect.

MySQL Driver

The MySQL driver can be installed after the initial RapidIdentity installation.

Audit Database

The Audit Database interface allows administrators to determine whether a specific database should be used for audit. 

Audit_Database_1.png

The default setting is False, which means that the local database is used for audit.

If the Audit Database is changed, it is necessary to Restart RapidIdentity for the change to take effect.

Start-At-Boot

The Start-At-Boot configuration allows RapidIdentity to start when the operating system is started.

For example, if RapidIdentity is hosted on an AWS EC2 Instance and Start-At-Boot is enabled, once the instance has passed its start up checks RapidIdentity will start and subsequently be available to access from a browser after a few minutes; RapidIdentity is available immediately from the command line after the instance passes its start up checks.

The default setting is enabled. To disable this configuration, select and confirm to disable. 

Start_At_Boot.png
Capabilities

The Capabilities menu item allows administrators to define the currently available capabilities. Selecting this option opens a prompt to edit Capabilities, which control the various functionalities that should be exposed by the RapidIdentity server.  

The advantage of this functionality in a unified RapidIdentity is that RapidIdentity back end processes are not dedicated to a component that isn't applicable. Therefore, RapidIdentity can run more efficiently.

Appliance_Capabilities_1.png

The end result is that the rapididentity.propertiescapabilities value is updated.

Appliance_Capabilities_2.png

Capabilities can be configured to inclusive or exclusive by adding prefixes of "+" or "-", respectively.

Each component in the table matches to a RapidIdentity Component, except for "admin" which refers to RapidIdentity Configuration components. The API is critical for any .ui or .jobs components.Swagger API Documentation

Table 218. Components

Component

UI

Jobs

admin

admin.ui

admin.jobs

connect

connect.ui

connect.jobs

federation

federation.ui

federation.jobs

folders

folders.ui

folders.jobs

portal

portal.ui

portal.jobs

studio

Note

Studio is only available in IDaaS environments

studio.ui

studio.jobs



Folders Notes

If the Cluster metadirectory is not pointing to Active Directory, the folders capabilities will continue running even with no tasks since RapidIdentity Folders is specific for Windows-based home or group shared folders.Cluster

Note

Best practice is to exclude or not enable any capabilities that are not licensed.

Wildcard Groups

The wildcard "all" can be used as a prefix in three possible ways with either an inclusion or exclusion.

  1. all: includes or excludes every UI and Job capability

  2. all.ui: includes or excludes every UI capability

  3. all.jobs: includes or excludes every Job capability

Inclusions and Exclusions

Inclusions and exclusions are processed in the order they occur and result in adding or removing from the set of capabilities.

  • If the list is empty, then all capability group is used.

  • If the list starts with an exclusion, then the initial set is the all capability group.

  • If the first item in the list is an inclusion, the initial set starts as empty.

  • Including or excluding a top level capability also includes or excludes all its subordinates (e.g. connect includes connect, connect.ui and connect.jobs).

  • Including a subordinate implies inclusion of its superior (e.g. federation.ui includes Federation).

  • Excluding a subordinate does not imply exclusion of its superior.

  • Including or excluding a group is equivalent to including or excluding each of the individual members of the group.

Table 219. Additional Capability Examples

Capability

Description

capabilities=

Includes all capabilities

capabilities=all

Includes all capabilities

capabilities=admin,connect

Includes admin, admin.ui, admin.jobs, connect, connect.ui, and connect.jobs.

capabilities=-folders

Includes all capabilities except folders.

capabilities=portal,-portal.jobs,federation

Includes portal, portal.ui, federation, federation.ui, and federation.jobs.



SSL/TLS Profile

The SSL/TLS Profile menu item defines which SSL Profile should be used with RapidIdentity. Selecting this option opens a prompt to edit the profile.Create an SSL Profile

The end result is that the rapididentity.properties tomcat.sslProfile value is updated.

Advanced

The Advanced menu item directs administrators to the rapididentity.properties configuration file.rapididentity.properties