Secret Models
Tenant secret and secret-injection data structures.
SecretInfo
Section titled “SecretInfo”Stored tenant secret metadata.
SecretInfo declaration
Section titled “SecretInfo declaration”interface SecretInfoSecretInfo properties
Section titled “SecretInfo properties”| 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. |
SecretStubInfo
Section titled “SecretStubInfo”Describes a secret-injection rule configured for one runtime.
SecretStubInfo declaration
Section titled “SecretStubInfo declaration”interface SecretStubInfoSecretStubInfo properties
Section titled “SecretStubInfo properties”| 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. |
DefaultSecretStubInfo
Section titled “DefaultSecretStubInfo”Default secret stub metadata copied to new runtimes.
DefaultSecretStubInfo declaration
Section titled “DefaultSecretStubInfo declaration”interface DefaultSecretStubInfoDefaultSecretStubInfo properties
Section titled “DefaultSecretStubInfo properties”| 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. |
SecretStubConfig
Section titled “SecretStubConfig”Defines how a stored credential is injected into matching requests.
SecretStubConfig declaration
Section titled “SecretStubConfig declaration”interface SecretStubConfigSecretStubConfig properties
Section titled “SecretStubConfig properties”| 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. |