Secrets Vault plugins · WorkFusion Documentation

Secrets Vault plugins provide the functionality to manage Secrets Vault. Secrets Vault plugins work using the /secrets-vault WorkFusion Rest API. To learn more, refer to Secrets Vault API.

At present, only the secrets-vault-get plugin is available for WorkFusion Studio.

secrets-vault-get

Open plugin description

The plugin enables you to retrieve secure values from Secrets Vault.

The plugin contains the following attribute:

Name	Required	Default	Description
`alias`	Yes		Secure entry alias.

The plugin stores a secure entry in the config context.

Example

<?xml version="1.0" encoding="UTF-8"?>
<config>

    ...

        <secrets-vault-get alias="my-keys" />

        <script><![CDATA[
                Map entryMap = secureEntryMap.getWrappedObject();
                com.freedomoss.crowdcontrol.webharvest.web.dto.SecureEntryDTO obj = entryMap.get("my-keys");
                username = obj.getKey().toString();
                password = obj.getValue().toString();
        ]]></script>
    <export include-original-data="true">
    </export>
    ...

</config>

secrets-vault-put

Open plugin description

The plugin allows saving confidential values to Secrets Vault.

The plugin contains the following attributes:

Name	Required	Description
`alias`	Yes	Key-value pair alias.
`key`	Yes	Secure name; usually username.
`value`	Yes	Secure value; usually password.

The result is a Boolean value—true or false—depending on whether an entry has been saved to Secrets Vault or not.

Example

<?xml version="1.0" encoding="UTF-8"?>
<config>

    ...
    <var-def name='result'>
        <secrets-vault-put alias="my-keys" key="username" value="password"/>
    </var-def>
    <export include-original-data="true">
    </export>
    ...
</config>

secrets-vault-delete

Open plugin description

The plugin provides the functionality to delete secure entries from Secrets Vault.

The plugin contains the following attributes:

Name	Required	Description
`alias`	Yes	Secure entry alias.

The result is a Boolean value—true or false—depending on whether the entry was deleted from Secrets Vault or not.

Example

<?xml version="1.0" encoding="UTF-8"?>
<config>

    ...
    <var-def name='result'>
        <secrets-vault-delete alias="my-keys" />
    </var-def>
    <export include-original-data="true">
    </export>
    ...
</config>

secrets-vault-update

Open plugin description

The plugin enables you to update secure entries (key and value) by alias.

The plugin contains the following attributes:

Name	Required	Description
`alias`	Yes	Key-value pair alias.
`key`	Yes	Secure name; usually username.
`value`	Yes	Secure value; usually password.

The result is a Boolean value—true or false—depending on whether the entry was updated in Secrets Vault or not.

Example

<?xml version="1.0" encoding="UTF-8"?>
<config>

    ...
    <var-def name='result'>
        <secrets-vault-update alias="my-keys" key="new_username" value="new_password" />
    </var-def>
    <export include-original-data="true">
    </export>
    ...
</config>

secrets-vault-reset

Open plugin description

The plugin provides the functionality to reset a secure entry value for a specific alias.

The plugin contains the following attributes:

Name	Required	Description
`alias`	Yes	Secure entry alias.

The result is a Boolean value—true or false—depending on whether the entry value was reset in Secrets Vault or not. A new value is randomly generated (20 symbols).

Example

<?xml version="1.0" encoding="UTF-8"?>
<config>

    ...
    <var-def name='result'>
        <secrets-vault-reset alias="my-keys" />
    </var-def>
    <export include-original-data="true">
    </export>
    ...
</config>