Skip to content

Reveal one item of the caller's own personal vault (step-up, audited, rate limited)

POST
/v1/console/secrets/reveal
curl --request POST \
--url 'https://example.com/v1/console/secrets/reveal?scope=tenant' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "description": "example", "name": "example", "value": "example" }'

Returns the plaintext of one item of the caller’s own vault// namespace, from the tenant scope only. Requires a signed-in person who passed the deployment’s step-up; another user, the superadmin and every token are refused, and global, mcp/, env/ and credential/ names never reveal. Rate limited per person, never cached, and recorded in the audit ledger without the value.

scope
string
Allowed values: tenant

Omit for superadmin global secrets; tenant selects the tenant’s own names: mcp/, env/ and credential/ for tenant admins, and every member’s personal vault// items for that member alone. Writes require the deployment’s step-up in either scope.

X-Olivares-Tenant
string format: uuid

Target tenant in explicit tenant mode.

Media type application/json
object
description
string
name
required
string
value
required
string format: password
Example generated
{
"description": "example",
"name": "example",
"value": "example"
}

OK

Media type application/json
object
name
string
value
string
Example generated
{
"name": "example",
"value": "example"
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated
{
"error": {
"code": "example",
"message": "example",
"module": "example"
}
}