8.5

Edit

Secure Store plugins

Secure Store plugins provide functionality to manage Secrets Vault. Secure Store plugins work using the /securestore WorkFusion Rest API.

secure-store-put

The plugin provides functionality for saving confidential values to Secure Storage.

The attributes are as follows:

Name
Required
Description
alias yes

alias of the key-value pair
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 saved in Secure Storage or not.

The example is as follows:

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

    ...
    <var-def name='result'>
        <secure-store-put alias="my-keys" key="username" value="password"/>
    </var-def>
</config>

secure-store-get

The plugin provides functionality for retrieving secure values from Secure Storage.

The attributes are as follows:

Name
Required
Default
Description
alias yes

alias of the secure entry
provider no SecureStorage secure entry provider

As a result, it stores a secure entry in the config context.

The example is as follows:

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

    ...
    
        <secure-store-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>
    
</config>

secure-store-delete

The plugin provides functionality for deleting secure entries from Secure Storage.

The attributes are as follows:

Name
Required
Default
Description
alias yes

alias of the secure entry

The result is a Boolean value: true or false, depending on whether the entry was deleted from Secure Storage or not.

The example is as follows:

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

    ...
    <var-def name='result'>
        <secure-store-delete alias="my-keys" />
    </var-def>
</config>

secure-store-update

The plugin provides functionality for updating secure entries (key and value) by alias.

The attributes are as follows:

Name
Required
Description
alias yes

alias of the key-value pair
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 Secure Storage or not.

The example is as follows:

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

    ...
    <var-def name='result'>
        <secure-store-update alias="my-keys" key="new_username" value="new_password" />
    </var-def>
</config>

secure-store-reset

The plugin provides functionality for resetting a secure entry value for a specific alias.

The attributes are as follows:

Name
Required
Default
Description
alias yes

alias of the secure entry

The result is a Boolean value: true or false, depending on whether the entry value was reset in Secure Storage or not. The new value is randomly generated (20 symbols).

The example is as follows:

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

    ...
    <var-def name='result'>
        <secure-store-reset alias="my-keys" />
    </var-def>
</config>
← PreviousNext →