Integration Configuration

Overview

The Integration Configuration module enables you to configure key system integrations, including Open API settings, encryption key rotation, and Single Sign-On (SSO) settings. This guide provides a step-by-step approach to managing these configurations efficiently.

Accessing Integration Configuration

1. Navigate to Integration Configuration in the system menu.

2. Expand the menu to view available configuration options:

   • Open API Configuration

   • Rotate Encryption Keys

   • Identity Provider/ Single Sign-On

Open API Configuration

Steps to Configure Open API Settings

1. Click Technical Configuration > Open API Configuration.

2. The Open API Configuration page appears.

3. Click on the Edit icon to modify the existing configuration.

4. Enter the required values:

   • Client ID: Enter the authentication client ID.

   • Client Secret Key: Enter the corresponding client secret key.

5. Click Cancel to discard unsaved changes at any time.

6. Click Save to confirm changes.

Rotate Encryption Keys

Steps to Rotate Encryption Keys

1. Click Technical Configuration > Rotate Encryption Keys.

2. The Rotate Encryption Keys page appears.

3. Click Rotate Encryption Key to generate a new encryption key and re-encrypt all stored passwords.

Identity Provider (Single Sign-On) Configuration

Adding a New Identity Provider

1. Click Technical Configuration > Identity Provider/Single Sign-On.

2. The Identity Provider/Single Sign-On page appears.

3. Click Add New.

4. Enter the required details:

   • Auth Type: Select SAML, OAuth, or OpenID.

   • Auth URL: Provide the authentication URL.

   • Sign-In Message: Customize the sign-in message if needed.

   • Allowed Domains: List domains permitted to use this provider.

   • Call Back URL: Enter the callback URL.

   • Self-Service Sign-Up: Set as True if supported.

5. Click Cancel to discard unsaved changes.

6. Click Done to save changes.

Editing an Existing Identity Provider

1. Locate the identity provider to edit.

2. Click Edit next to the provider.

3. Modify the required details:

   • Auth Type, Auth URL, Sign-In Message, Allowed Domains, Call Back URL, and Self-Service Sign-Up.

4. Click Cancel to discard unsaved changes.

5. Click Done to save modifications.

Proper configuration ensures seamless communication between system components and external services. Regularly review and update integration settings to maintain system security and functionality.