Secret value
Included from Basic tier
Secret values are never stored as a resource of their own — they live in
the configured secrets backend and ride the API only as per-value
operation outcomes. A resolve, encrypt, store or store-file call answers
one SecretResult per requested value, and a refusal is embedded in the
result text rather than failing the batch. Served by the v2
SecretsService (ResolveSecrets, ResolveGlobalSecret,
EncryptSecret, StoreSecret, StoreSecretFile, the user vault
credential verbs and the vault-entry listings); every verb authorises
server-side against the secrets rule paths.
SecretResult
SecretResult is one per-value outcome: the requested source value, and the resolved/stored/encrypted result — or its refusal, an embedded string starting "ERROR: " (the v1 named-refusal contract).
| Field | Type | Meaning |
|---|---|---|
filename | string | The owning file's basename when the owner data stores the value as an opschain.files entry's content (resolve), or the uploaded file's name (store_file); unset otherwise. |
result | string | The outcome: the resolved plaintext (resolve verbs), the cipher-stacked text (encrypt/store — store substitutes a fixed placeholder when the vault stores values unencrypted), or an "ERROR: …" refusal. |
source | string | The value as requested (the vault URL on store verbs). |
SecretsAuthorisations
SecretsAuthorisations is the v1 node-show meta.authorisations.secrets triple the estate shows report: may the caller decrypt the node's settings/properties/MintModel secret values from the GUI. The flags mirror the v1 node serializer's contract exactly (superuser-only); the secrets RPCs themselves authorise server-side against the SecretsPolicy rule paths regardless.
| Field | Type | Meaning |
|---|---|---|
mintmodel | boolean | May the caller decrypt the node's MintModel secret values from the GUI. |
properties | boolean | May the caller decrypt the node's properties secret values from the GUI. |
settings | boolean | May the caller decrypt the node's settings secret values from the GUI. |
Related pages
opschain docs resources/secrets_provider— the backend connections values resolve through.opschain docs secrets-providers— the component page: custody, cipher stacking and grants.opschain docs getting-started/3-5-secrets-and-the-vault— the operator walk-through.