Skip to content

Secret Models

Tenant secret and secret-injection data structures.

Stored tenant secret metadata.

interface SecretInfo
Name Type Description
cacheTtlSecs number How long injected values may be cached, in seconds.
displayName string Human-readable resource name.
id string Unique resource UUID.
valuePreview? string | null Redacted preview of the stored value, when available.

Describes a secret-injection rule configured for one runtime.

interface SecretStubInfo
Name Type Description
hostPattern string Outbound host pattern matched by the stub.
id string Unique resource UUID.
pathPattern string Optional request path pattern matched by the stub.
runtimeDisplayName string Runtime that owns this stub.
stubConfigJson string Serialized injection configuration.
stubValueDisplayName string Stored secret injected by the stub.

Default secret stub metadata copied to new runtimes.

interface DefaultSecretStubInfo
Name Type Description
hostPattern string Outbound host pattern matched by the stub.
id string Unique resource UUID.
pathPattern string Optional request path pattern matched by the stub.
stubConfigJson string Serialized injection configuration.
stubValueDisplayName string Stored secret injected by the stub.

Defines how a stored credential is injected into matching requests.

interface SecretStubConfig
Name Type Description
credential string Stored secret name to inject.
header? string HTTP header that receives the credential.
param? string Query parameter that receives the credential.
value? string Template used for the injected header value.