Skip to content

Secret Models

Tenant secret and secret-injection data structures.

Stored tenant secret metadata.

interface SecretInfo
NameTypeDescription
cacheTtlSecsnumberHow long injected values may be cached, in seconds.
displayNamestringHuman-readable resource name.
idstringUnique resource UUID.
valuePreview?string | nullRedacted preview of the stored value, when available.

Describes a secret-injection rule configured for one runtime.

interface SecretStubInfo
NameTypeDescription
hostPatternstringOutbound host pattern matched by the stub.
idstringUnique resource UUID.
pathPatternstringOptional request path pattern matched by the stub.
runtimeDisplayNamestringRuntime that owns this stub.
stubConfigJsonstringSerialized injection configuration.
stubValueDisplayNamestringStored secret injected by the stub.

Default secret stub metadata copied to new runtimes.

interface DefaultSecretStubInfo
NameTypeDescription
hostPatternstringOutbound host pattern matched by the stub.
idstringUnique resource UUID.
pathPatternstringOptional request path pattern matched by the stub.
stubConfigJsonstringSerialized injection configuration.
stubValueDisplayNamestringStored secret injected by the stub.

Defines how a stored credential is injected into matching requests.

interface SecretStubConfig
NameTypeDescription
credentialstringStored secret name to inject.
header?stringHTTP header that receives the credential.
param?stringQuery parameter that receives the credential.
value?stringTemplate used for the injected header value.