Document toolboxDocument toolbox

Kyvos Manager integration with Kyvos Web Portal and role mapping

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

  • GenAI Configuration

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 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 of Kyvos Manager's functionality through Kyvos, you need to log in to Kyvos Manager, go to the toolbox, and select the 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, do not upload this reference file.

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

Mapping Roles

You can automatically map Kyvos user roles with Kyvos Manager roles to ensure appropriate privileges for users logging in via the Kyvos integration process.

In Kyvos Manager, you need to map Kyvos roles to Kyvos Manager roles to ensure that menu items are displayed in the Setup > Manage Kyvos section according to the role mapping and privileges.

Note

The new deployment automatically maps the Kyvos Administrator role to the Kyvos Manager Integration role.

The Manage Kyvos section in Kyvos is only applicable to the Kyvos Administrator.

To map roles, perform the following steps.

  1. On the navigation pane, click Kyvos Manager Settings > Roles Mapping.

  2. Click Fetch Kyvos Roles.

    image-20240717-094945.png
  3. On the Fetch Kyvos Roles dialog box, enter your Kyvos username and password.

  4. Click Fetch. All Kyvos roles will be displayed in the Kyvos Role list.

  5. Select the Kyvos Role and the Kyvos Manager Role from the list. This is required to map the roles. You can also add a new mapping.

  6. Click Save. The role mapping is completed.

 

Copyright Kyvos, Inc. All rights reserved.