Secrets Vault API

Description

The password parameter requires the BCrypt Encoded value with the strength measure of 10.

tip

You can use Secrets Vault Plugins as part of Business Processes.

Configuration

The service is published under the following URL: /api/v1/secrets-vault.

URL examples

https://custom-name.workfusion.com/workfusion/api/v1/secrets-vault

API security

For authentication details, see WorkFusion REST API | API security.

Get secure entry

Resource path: v1/secrets-vault/entry

Method: POST

Description: Retrieves secure entry from Secrets Vault.

Parameter	Description	Required	Param Type	Data Type
alias	Alias of the secured entry	Yes	x-www-form-urlencoded	String

Successful output:

{
    "responseStatus": "SUCCESS",
    "body": {
        "alias": "333",
        "key": "0000000",
        "value": "0000000000",
        "lastUpdateDate": 1449814392229
    },
    "errors": []
}

Error output: Invalid UUID

{
    "responseStatus": "FAILURE",
    "body": null,
    "errors": [
        {
            "code": 22,
            "message": "Invalid password"
        }
    ]
}

Save secure entry

Resource path: v1/secrets-vault/entry/put

Method: POST

Description: Saves the provided entry to Secrets Vault.

Parameter	Description	Required	Param Type	Data Type
alias	Alias of the secured entry	Yes	x-www-form-urlencoded	String
key	Entry key, which is usually a username	Yes	x-www-form-urlencoded	String
value	Entry value, which is usually the password	Yes	x-www-form-urlencoded	String

Successful output:

{
    "responseStatus": "SUCCESS",
    "body": true,
    "errors": []
}

Error output: Invalid UUID

{
    "responseStatus": "FAILURE",
    "body": null,
    "errors": [
        {
            "code": 20,
            "message": "Secure Entry 1211 already exists"
        }
    ]
}

Delete secure entry

Resource path: v1/secrets-vault/entry/delete

Method: POST

Description: Deletes the specified entry from Secrets Vault.

Parameter	Description	Required	Param Type	Data Type
alias	Alias of the secured entry	Yes	x-www-form-urlencoded	String

Successful output:

{
    "responseStatus": "SUCCESS",
    "body": true,
    "errors": []
}

Error output: Invalid UUID

{
    "responseStatus": "FAILURE",
    "body": null,
    "errors": [
        {
            "code": 22,
            "message": "Invalid password"
        }
    ]
}

Update secure entry

Resource path: v1/secrets-vault/entry/update

Method: POST

Description: Updates the specified entry (key, value) by alias to Secrets Vault.

Parameter	Description	Required	Param Type	Data Type
alias	Alias of the secured entry	Yes	x-www-form-urlencoded	String
key	Entry key, which is usually the username	Yes	x-www-form-urlencoded	String
value	Entry value, which is usually the password	Yes	x-www-form-urlencoded	String

Successful output:

{
    "responseStatus": "SUCCESS",
    "body": true,
    "errors": []
}

Error output: Invalid UUID

{
  "message": "Validation Failed",
  "code": "com.workfusion.api.error.missing.request.parameter",
  "errors": [
    {
      "message": "Required String parameter 'key' is not present",
      "field": "key"
    }
  ]
}

Reset secure entry

Resource path: v1/secrets-vault/entry/reset

Method: POST

Description: Resets the value for the specified entry from Secrets Vault. The new value is generated randomly. The length is 20 symbols.

Parameter	Description	Required	Param Type	Data Type
alias	Alias of the secured entry	Yes	x-www-form-urlencoded	String

Successful output:

{
    "responseStatus": "SUCCESS",
    "body": true,
    "errors": []
}

Error output: Invalid UUID

{
  "message": "Secure Entry with alias '12342222' does not exist",
  "code": "com.workfusion.api.error.http.not.found"
}