The Credential module provides a streamlined solution for storing and managing authentication credentials for databases, remote machines, and application servers. Organizations dealing with multiple databases or APIs often face repetitive credential entry, raising concerns about security and password exposure.

Benefits of Credentials 

Encryption and Decryption 

Bridge offers several types of credentials to extend support to different types of services and resources. Each credential type serves specific purposes and has its own set of parameters. Below are the available credential types:

1. API Key 

An API key is a unique code used to identify the application or user making an API request. Based on the scope defined while generating an API Key, it grants access to APIs for data retrieval, updates, or specific actions. API credentials created here can be utilised in Bridge, Circuit, API LookUp fields, and Webhooks. The details required to create API Key Credential are:

• Token: The token generated in the service where the API request is intended to be sent. It is included as a header or parameter in the API request to identify and authorise the requester.

• Header: Name of the HTTP header that carries the API token or other authentication information. Common header names for API tokens include:

• Authorization

• API-Key

• Bearer

• Parameter: Names of the query parameters or request body parameters used to pass the API token during an API request. 

2. JDBC  

JDBC credentials provide access to a database connection. When connecting to a database using JDBC, you need to provide a username and password associated with the database account that has the necessary permissions for required database operations. JDBC Credentials created here can be used in Bridge, Circuit, and DB LookUp fields. The below details are required to create a JDBC Credential.

• Username/Password: The username and password associated with the database account you want to use.

3. OAuth 2.0  

In Qntrl, a Connection, can be created and used in Deluge integration tasks or custom functions, to enable users to interact with their chosen service. Connection is based on OAuth 2.0 and acts as a way of login to a service. This type of Credential can store the details of a Connection, to facilitate the execution of Webhooks of any application.

Currently, OAuth 2.0 credentials can be saved and used in only Qntrl cloud, exclusively in Webhooks and cannot be used in Bridge agent. The details required to create OAuth 2.0 Credential is given below.

• OAuth Connection: Input the Connection Link Name of the Connections.

4. SSH  

SSH credentials are used to connect UNIX and Linux devices securely and execute commands over the Secure Shell (SSH) protocol. SSH Credentials created here are used in Bridge and Circuit. The below details are required to create a SSH Credential.

• Username/Password: The username and password of the machine where the shell script is intended to be executed.

5. PowerShell  

The credentials of this type are used to connect with Windows machines and execute PowerShell commands securely. PowerShell Credentials created here are used in Bridge and Circuit. The below details are required to create a PowerShell Credential.

• Username/Password: The username and password of the machine where the PowerShell script is intended to be executed.

6. Active Directory  

These credentials are used for authenticating and accessing resources within an Active Directory (AD) environment. AD Credentials created here are used in Bridge and Circuit.

• User DN: Distinguished Name of the Active Directory.

• Password: Password of the Active Directory.
  

 Create a credential   

1. Click the settings gear icon at the top right of the header bar.

2. Navigate to Advanced >> Bridge >> Select Credentials.

3. Click New Credential button.

4. Fill in the new credential details.
   

1. API Key - If the credential type is API key, mention the API token. 
   
1.  Append To: Select Parameter or Header to append the credential   
   
2. Parameter or Header name: Give a name for Parameter or Header    
2. JDBC - For credential type JDBC, specify the User Name and Password.
   
3. OAuth 2.0 - If the credential type is OAuth 2.0, select the existing DRE connections.
   
4. SSH - Provide User Name and Password of the machine where the Shell script has to be executed.
   
5. Powershell - Provide User Name and Password of the machine where the Powershell script will be executed.
   
6. Active Directory - Specify User DN and Password of the Active Directory
   

1. Credential Name in Bridge: Mention the saved Credential name.

5. Click Save.

Edit a Credential   

To update the details of an existing Credential:

1. Navigate to(settings) >> Advanced >> Bridge >> select Credentials.

2. Select the credential you want to edit by clicking on the credential name.

3. In the opened credential page, make modifications and click Save. 

Delete a Credential   

To delete an existing credential:

1. Navigate to(settings) >> Advanced >> Bridge >> select Credentials.

2. Hover over the name of the Credential you want to delete, click mouse over action menu, , and select Delete.

3. Confirm your delete action.