Get Secret

Reads a secret asset as a SecureString.

Behaviour

Risk: None · Idempotent: Yes · Safe to retry: Yes · Recovery: Replayed after a crash

Package Orchestrator activities VeloPhex.Orchestrator.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.orchestrator.getSecret

Properties#

Input#

Secret Name#

SecretName · String · Required · Default: Not specified in package metadata

The name of the secret asset in the job's workspace.

Output#

Secret#

Secret · SecureString · Output · Sensitive

The secret's value, as a SecureString: masked everywhere and never saved with the workflow's state.

Retry and risk#

This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Related activities#

• Get Asset
• Get Credential
• Set Asset
• Set Credential
• Set Secret

Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Assets. Keywords: secret, password, token, key, api key, securestring, asset, orchestrator.

Properties

Input

Output

Retry and risk

Related activities