Document toolboxDocument toolbox

Kyvos Manager integration with Kyvos Web Portal

Kyvos Manager integrates seamlessly with the Kyvos Web Portal for AWS Managed Services. This integration is exclusively available for users with Admin privileges. Upon logging into the Kyvos Web Portal, an Admin user will find an option to Manage Kyvos in the Setup menu in the toolbox. Upon selecting this option, Kyvos Manager will open in a new tab, facilitating easy navigation to default menu items.

The following are the default menu items:

  • Properties

  • Kyvos Authentication

  • Data Security

  • Web Based SSO

To enable this functionality on other cloud platforms such as Azure and GCP or on-premises, you must set the EMBED_KYVOS_MANAGER property to Yes. To do this, navigate to the Kyvos Properties page by clicking on Kyvos and Ecosystem > Kyvos Properties. On the Kyvos Properties page, expand the kyvosclient.properties, find the EMBED_KYVOS_MANAGER property, and set its value to ‘Yes’.

To manage more functionality of Kyvos Manager through Kyvos, you need to login to Kyvos Manager, in the toolbox, go to Utilities > Manage Configuration Files option.

Note

The Manage Configuration Files option is not supported in the integrated mode.

To access the Kyvos Manager configurations, go to the Manage Configuration Files page and click Kyvos Manager. Next, navigate to kyvosmanager/conf/ location where you will see two files: integration.config.help.json and integration.config.json.

  • integration.config.help.json: This is a reference file that contains sample configurations You can copy and paste configurations from this reference file into your configuration file (integration.config.json). However, ensure that you must not upload this reference file.

  • integration.config.json: This is the configuration file you need to download, add configurations, and then upload back. Once uploaded, all the required configurations will be enabled and displayed when you click the Manage Kyvos option in the Kyvos Web Portal.

Using ‘integration.config.help.json’ configuration file

The ‘integration.config.help.json’ file contains all Kyvos Manager toolbar configurations. It is essential for quickly setting up configurations in Kyvos Web Portal in integration mode. In order to complete the process, you will need to copy the necessary configurations and paste them into the ‘integration.config.json’ file. Once this is done, the required toolbar menu items of the Kyvos Manager will appear in the Manage Kyvos section of the Setup menu in the toolbox. By doing this, you will be able to manage your Kyvos configurations more efficiently and streamline your workflow.

Points to Know:

  • You can only set the value to True or False.

  • You can add any required Kyvos Manager menu item in the ‘menuList’ section, as shown below. The added menu will appear in the Kyvos Web Portal in integration mode.

  • The uploaded JSON file must be valid.

 

Copyright Kyvos, Inc. All rights reserved.