Skip to content

Current authenticator code of one of the caller's own vault items (step-up, audited, rate limited; never the seed)

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

Returns the current RFC 6238 authenticator code and the seconds it stays valid for one item of the caller’s own vault// namespace, from the tenant scope only; the seed is never returned. Guarded and limited exactly like reveal (signed-in person with the deployment’s step-up, owner only, rate limited per person), never cached, and recorded in the audit ledger without the code.

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
code
required
string format: password
digits
required
integer
period
required
integer
seconds_left
required
integer
Example generated
{
"code": "example",
"digits": 1,
"period": 1,
"seconds_left": 1
}

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"
}
}