Secret programs: revoke, rotate, store

Reference for Secret, one group of Secret programs.

Secret.revoke

Revoke ends a Secret so no call fills it again; the record and its history stay. Verb page.

Text

do: return await $.Secret.revoke(input)

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Secret.revoke({ secret: 'secret_UaNXUkKsJB' })"
  }
}

Rotate replaces a Secret’s value, and calls already running finish on the old one. Verb page.

Text

do: return await $.Secret.rotate(input)

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Secret.rotate({ secret: 'secret_UaNXUkKsJB' })"
  }
}

Store writes a Secret’s value for one environment; the value is never returned by any Interface. Verb page.

Text

do: return await $.Secret.store(input)

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Secret.store({ name: 'MAPS_KEY', value: 'Example value', environment: 'test' })"
  }
}