Help Center/ Cloud Bastion Host/ User Guide/ Resource Operation/ Database Operations/ Using an SSO Client to Log In to a Database Resource for Operations
Updated on 2026-09-17 GMT+08:00

Using an SSO Client to Log In to a Database Resource for Operations

You can use single sign-on (SSO) tools to call the database client for database resource operations and operation audits. Before you start, install the SSO and database client tools and then configure the path of the database client tool.

This topic describes how to configure the SSO client and how to use the SSO tool to log in to database resources.

Notes and Constraints

  • The database operation audit is available only in professional editions.
  • The client tool can be invoked only through SsoDBSettings.
  • Only SecureCRT and Xshell host resource operation clients can be used.
  • Multiple Navicat clients can be opened to maintain databases.
  • The client timeout period (Idle timeout in Configuring Client Login) configured in the system does not apply to MongoDB databases.
  • If you upgrade a bastion host of a version earlier than V3.3.56.0 to V3.3.56.0 or later, you need to download and install SsoDBSettings again. You can click in the upper right corner to go to the download center and download SsoDBSettings on the Common Tools tab.
  • The following table lists the supported database protocols and corresponding clients.
    Table 1 Supported database types, versions, and clients

    Database Type

    Version

    Supported Client

    MySQL

    5.5, 5.6, 5.7, and 8.0

    Navicat 11, 12, 15, and 16

    MySQL Administrator 1.2.17

    MySQL CMD

    DBeaver 22 and 23 (supported by bastion host V3.3.48.0 and later)

    Microsoft SQL Server

    2014, 2016, 2017, 2019, and 2022

    Navicat 11, 12, 15, and 16

    SSMS 17.6, 18, and 19

    Oracle

    10g, 11g, 12c, 19c, and 21c

    Toad for Oracle 11.0, 12.1, 12.8, and 13.2

    Navicat 11, 12, 15, and 16

    PL/SQL Developer 11.0.5.1790

    DBeaver 22 and 23 (supported by bastion host V3.3.48.0 and later)

    DB2

    DB2 Express-C

    DB2 CMD command line 11.1.0

    PostgreSQL

    11, 12, 13, 14, and 15

    DBeaver 22 and 23

    GaussDB

    2 and 3

    DBeaver 22 and 23

    DM

    DM8

    DM management tool V8 (supported in Build 2023.12.14)

    Redis

    5.0 and 6.0

    redis-cli x64 5.0.9 (git:9414ab9b)

    MongoDB

    4.4, 5.0, and 8.2.0

    Navicat 15, 16, and 17

    • You need to download the database versions supported.
    • If you want to use an SSO tool for GaussDB databases, download the JDBC driver package of V2.0-3.x by referring to Using JDBC to Connect a Database first. Then delete all files from the Library in Database > Driver Manager, and add the downloaded JDBC driver package.
    • If you need to use an SSO tool for PostgreSQL and GaussDB databases, add the sslmode attribute to the connection attributes in Database > Driver Manager and save the value as disable.
    • The SsoTool.msi remote tool can be installed only in the default path C:\sso\SsoTool. If you install it in other paths, the tool may fail to be started.
    • A bastion host cannot verify the databases with SSL enabled. When connecting to GaussDB databases, you need to disable SSL (sslmode) on DBeaver.

Prerequisites

  • You have the management permissions for the Host Operations module.
  • You have obtained the access permissions for the resources.
  • You have installed the client tool.
  • The network connection between the managed host and the system is normal, and the account username and password for logging in to the managed host are correct.

Procedure

  1. Log in to your bastion host system.
  2. Choose Operation > Host Operations to go to the Host Operations page.
  3. Quickly search for the target database.

    1. Expand Resource Group on the left to check the resource group view.

      In the Personal Resource Group or Public Resource Group area on the left of the content pane, click a resource group name. Then only the host or database resources in the selected resource group will be displayed in the list. If no resource group is selected, all host or database resources are displayed by default.

    2. Above the host list, enter a keyword in the search box to quickly search for resources by host name or host address.

  4. Select the host with protocol set to database, and click Login.

    The client tool selection window is displayed.

    • When you first time log in to the database, you will see the SsoDBSettings download window.
    • The download tool varies depending on the bastion host version you are using.

      For example, if you are using V3.3.44.0, SSO tool Windows and UOS (Arm) are provided. You can select either of them from the drop-down list.

  5. Select the client tool that has been installed and click OK.

    The system automatically calls the local database client tool to log in to the database.

Configuring the SSO Client

The following uses the Navicat client as an example to describe how to configure the client path.

  1. Start local SSO tool SsoDBSettings.
  2. Click the path configuration icon next to Navicat Path.
  3. Find the absolute path where the Navicat client is installed, select the .exe file, and click Open.
  4. Go to the SsoDBSettings SSO tool configuration page and view the selected Navicat client path.
  5. Click Save to return to the Host Operations page in your bastion host. Then, you can log in to the database.