type | string (one of) | yes | | opaque, password, token, tls, ssh-key, cloud-credential, webhook | What kind of secret this is; it fixes the key names of the data (password: password and optionally username; token: token; tls: tls.crt and tls.key; ssh-key: private-key and optionally public-key; cloud-credential: credential; webhook: secret and optionally url; opaque: any). Cannot be changed. |
description | string | | | up to 200 characters | What the secret is for, shown in lists. Never put the value here. |
data | object | | | | WRITE-ONLY. The value as key to base64 string. Accepted on create and update, removed during admission, never returned. At most 32 keys, decoded values together at most 64 KiB. |
stringData | object | | | | WRITE-ONLY. Like data, with plain UTF-8 strings instead of base64. Merged into data. |
generate | object | | | | The platform makes the value instead of you typing it. Cannot be combined with data on create. A generated secret is rotated, never written. |
generate.kind | string (one of) | yes | | password, token, bytes, ed25519 | password: letters and digits. token: random bytes in base64url. bytes: raw random bytes. ed25519: a signing key pair (private-key seed and public-key). Cannot be changed. |
generate.length | integer | | | 16 to 1024 | Characters (password), bytes (token, bytes). Default 32; password and token at most 128. Ignored for ed25519. |
generate.reveal | string (one of) | | "never" | never, once | once: the value is returned once, in the response of the write that made it (spec.generated), and nowhere else. never: only the reveal path and sandboxes ever receive it. |
rotation | object | | | | When and how the value changes. |
rotation.intervalSeconds | integer | | | at least 3600 | Rotate generated or issued secrets this often. For a typed secret, the age after which RotationDue is reported (the owner of the value rotates it). |
rotation.gracePeriodSeconds | integer | | 3600 | 0 to 604800 | How long the previous version stays deliverable after a new one becomes current. |
rotation.requestedAt | string | | | up to 64 characters | Change this string to rotate a generated secret now. Any value is accepted; only a change counts. |
expiresAt | string | | | up to 40 characters | When the value stops being valid at its owner (RFC 3339). Drives the Expiring and Expired phases. |
warnBeforeSeconds | integer | | | at least 0 | How long before expiresAt the secret is reported as Expiring. Default 7 days; none for an issued secret, which its issuer renews before it ends. |
issuer | object | | | | The value is minted short-lived by a named credential issuer (spec 0039 section 10) and renewed before it ends. |
issuer.name | string | yes | | up to 63 characters | Name of the issuer component. |
issuer.config | object (free-form) | | | | Non-secret settings for the issuer (audience, role, scope). At most 4 KiB. |
delivery | object | | | | Publish the value to operators' credential stores. Only in the root cluster and in system projects. |
delivery.credentialStore | object | | | | Put one key of the value into the host credential store under this secret's name, for kinds that name credentials there (a cloud account's credentialRef). |
delivery.credentialStore.key | string | yes | | up to 63 characters | Which key of the data to publish. |
bootstrap | object | | | | When the platform cannot renew this secret by itself (it expires, or its renewal fails), it asks a person with a BootstrapRequest built from this. Only in the root cluster and in system projects. |
bootstrap.purpose | string | yes | | length 1 to 200 | What the credential is for. |
bootstrap.provider | string | yes | | length 1 to 63 | Whose credential it is. |
bootstrap.steps | list of string | yes | | up to 20 items | The exact steps for the person. Never a value. |
custody | object | | | | This secret stands for a platform key that exists outside the platform (a master key) and holds no value: it is Ready while custodians have confirmed recently (Approval of type Custody). Type must be opaque; it cannot be revealed. |
custody.holders | list of string | yes | | up to 10 items | Who can produce the key (names of people or roles, not contact details). |
custody.verifyEverySeconds | integer | yes | | at least 3600 | How often custodians must confirm. |
sealed | object (free-form) | | | | Server-managed ciphertext of the sealed versions. Never settable by a client and never returned. |