DeleteSecret

This activity enables you to remove a specific secret from a designated Key Vault in Azure. Ensure it is used within the appropriate scope activity.

Pre- Requisites

Before removing secrets from your Key Vault, please consider the following guidelines:

1. For Permanent Deletion:

a. Ensure “Purge Protection” is disabled when creating your Key Vault if you wish to permanently delete credentials immediately.
b. With “Purge Protection” disabled, you can use the “Permanent” delete option to eliminate secrets immediately without a recovery period.

2. To Recover Deleted Credentials:

a. The “Retention Period” set during the creation of your Key Vault determines how long you can recover deleted credentials.
b. By default, this period lasts 90 days, but you can choose a different duration if needed.
c. Keep in mind that if “Purge Protection” is enabled, you can only recover deleted secrets during the retention period

3. For more details, click here.

Properties 

INPUT

DeleteType: This parameter indicates the deletion type for your credentials.

Recover: Opting for this allows the user to recover deleted credentials within the configured retention period.
Permanent: Opting for this allows the user to permanently remove deleted credentials from your Key Vault.

For more details, refer the pre-requisites.
By default, the option will be set to “Recover.”

KeyVaultURI: *This parameter specifies the “Vault URI” for your Key Vault created in Azure services. It’s used to authenticate the specific Azure Key Vault between Robility and Azure services.

This parameter accepts values in “String” datatype. You can either hardcode the values in “String” format or provide the value in String” datatype.

MethodType: This parameter specifies the method type of the execution mode.

Normal: It allows the bot to execute the activity completely before proceeding to the next activity.

Async: It allows the bot to run the activity in the background without causing any disruption to the user interface (UI) performance. It is ideal for scenarios where the activity can continue running independently, when there is no immediate activity for further execution.

By default, the method type is set to “Normal”.

SecretName*: This parameter specifies the name of the secret for which the secret values should be deleted from the specified Azure Key Vault.

It accepts values in “String” datatype. You can either hardcode the values in “String” format or provide the value in String” datatype.

MISC

Body: Gets auto filled once the “Activity” is dropped into the body.

DisplayName: Displays the name of the activity. The activity name can be customized, which aids in troubleshooting.

SkipOnError: Specify the “Boolean” value as “True” or “False.”

True: Continue executing the workflow regardless of any errors thrown.
False: Halt the workflow if it encounters any errors.
None: If the option is left blank, the activity will, by default, behave as if “False” were chosen.

Version: It indicates the version of the feature being used.

OUTPUT

DeletedStatus*: It provides the result of the status of the secret deleted in the key vault in Azure. It returns values in “Boolean.”

True: Indicates that the activity has been executed successfully without any errors.
False: Indicates that the activity has been unsuccessful due to an unexpected error being thrown.

Result: It provides the ability to view the execution status of the activity. It returns values in “Boolean.”

True: Indicates that the activity has been executed successfully without any errors.
False: Indicates that the activity has been unsuccessful due to an unexpected error being thrown.

* Represents mandatory fields to execute the workflow.