Skip to main content
POST
CreateSecret

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json
value
value · object
required
name
string
comment
string | null

Response

Success

Metadata only. Secret material is returned exclusively by AccessSecret.

name
string

Immutable resource name: secrets/{secret}.

uid
string

Immutable UUID identity.

version
string<int64>

Monotonically increasing version of the stored value. References use the current version.

comment
string | null
kind
enum<string>
Available options:
KIND_UNSPECIFIED,
KIND_GENERIC,
KIND_AWS,
KIND_GCP,
KIND_AZURE
created_by
string | null
updated_by
string | null
created_at
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

updated_at
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

workspace
string

The workspace that owns the Secret, its creating credential's; the name is unique in it.

cf. Zitadel resource_owner; Modal secrets belong to a workspace.