Azure Key Vault

Discover more about the Azure Key Vault connector and how to use it on the Digibee Integration Platform.

Azure Key Vault manages secrets and keys in Azure Key Vault Service.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter	Description	Default value	Data type
Account	The account used by the connector. It must be an Azure Key account type.	N/A	Account
Vault Name (DB)	Vault Name to be used.	N/A	String
Operation	Operation to be performed. Options are: Create Secret, Delete Secret, Get Secret, and Purge Deleted Secret.	Get Secret	String
Secret Name (DB)	The secret name to be used in Key Vault.	N/A	String
Secret Value (DB)	The secret value to be used in Key Vault. Available only when the operation is Create Secret.	N/A	String
Fail On Error	If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	False	Boolean

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Section for documenting any necessary information about the connector configuration and business rules.	N/A	String

Operations

Create Secret

This operation creates a new secret in a Key Vault. Provide the following:

• Secret Name

• Secret Value

Example

• Secret Name: createKey123

• Secret Value: 123456

Output

If successful, the output will be:

{
  "success": true,
  "body": {
    "name": "createKey123",
    "value": "123456",
    "expiresOn": "",
    "createdOn": "2024-10-30T16:30:12Z",
    "updatedOn": "2024-10-30T16:30:12Z"
  }
}

Delete Secret

This operation deletes a specified secret from a Key Vault. Provide:

• Secret Name

Example

• Secret Name: createKey123

Output

If successful, the output will be:

{
  "success": true
}

Get Secret

This operation retrieves a specified secret from a Key Vault. Provide:

• Secret Name

Example

• Secret Name: createKey123

Output

If successful, the output will be:

{
  "success": true,
  "body": {
    "result": "123456"
  }
}

Purge Deleted Secret

This operation permanently removes a deleted secret from a Key Vault. Unlike the Delete Secret operation, the secret cannot be recovered after purging. Provide:

• Secret Name

Example

• Secret Name: createKey123

Output

If the operation is successful, you will receive the output:

{
  "success": true
}