Secret commands: revoke, rotate, store
The Secret Verbs revoke, rotate, store as CLI commands, with inputs, result, refusals and an example.
Reference for Secret, one group of Secret commands.
Secret.revoke
Revoke ends a Secret so no call fills it again; the record and its history stay. Verb page.
npx startup-builder do Secret.revoke --json '<input>' [--try | --send | --do]Emits Secret.revoked.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
secret | Secret | required | The Secret to revoke. |
reason | text | Why, such as a leaked value. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
secret | Secret | required | The revoked Secret. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Secret.revoke --json '{"secret":Secret.rotate
Rotate replaces a Secret’s value, and calls already running finish on the old one. Verb page.
npx startup-builder do Secret.rotate --json '<input>' [--try | --send | --do]Emits Secret.rotated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
secret | Secret | required | The Secret to rotate. |
value | string | The new value; omitted when the upstream issues one. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
secret | Secret | required | The Secret, with its new rotatedAt. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Secret.rotate --json '{"secret":Secret.store
Store writes a Secret’s value for one environment; the value is never returned by any Interface. Verb page.
npx startup-builder do Secret.store --json '<input>' [--try | --send | --do]Emits Secret.stored.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
name | string | required | The name Functions declare. |
value | string | required | The credential; write-only. |
environment | string | required | Where it holds. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
secret | Secret | required | The Secret, without its value. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Secret.store --json '{"name":