Security: Retrieve a credential from the local vault

Retrieve a credential from the local vault.

Help Centre › Credentials & Connections

Retrieve a credential from the local vault.

Add it to a process

In the process designer, open the Add step tab. Find Retrieve a credential from the local vault under Security, or type its name in the search box, and drag it onto the canvas.

Fields

FieldRequiredWhat it does
Credential nameYesCredential name
VariableYesVariable to store result Default: credential.
FieldNoSpecific field to retrieve (returns all if omitted)

What it gives back

  • {credential} – Credential value or dict of all fields

See all Security steps.

Errors

ErrorDescription
Credential not foundNo credential exists with the specified name
Decryption failedThe credential could not be decrypted, possibly due to a corrupted key

Tips

  • Use the field parameter to get just the password or token instead of the full credential object
  • Omit the field parameter to retrieve all fields as an object

Related functions

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.