Secret

Metadata for a stored secret. The stored value is included only when it is explicitly revealed.

id
Type: string
required

Unique identifier for the secret.
object
enum
const:
secret
required
values
- secret
  
  A stored secret.
created
Type: stringFormat: date-time
required

Time when the secret was first stored.
updated
Type: stringFormat: date-time
required

Time when the secret was last replaced.
name
Type: string
required

Name used to retrieve the secret.
livemode
Type: boolean
required

Whether the secret belongs to the live environment (true) or test environment (false).
expires_at
Type: stringFormat: date-time

Time when the secret expires, when an expiration is set.
scope
Type:
required

Account and environment boundary of the secret.

Properties: 1
payload
Type: string

Stored value. Present only when the Find a secret request includes reveal=true.