Skip to content
Olivares AI docs

Generate a random password for the signed-in member; nothing is stored

POST
/v1/console/secrets/generate
 
curl --request POST \
  --url 'https://example.com/v1/console/secrets/generate?scope=tenant' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "digits": true, "length": 20, "lower": true, "symbols": true, "upper": true }'

Returns a random password for the signed-in member: 8 to 128 characters (20 by default) with at least one character of every chosen kind (lowercase, uppercase, digits, symbols). Nothing is stored or recorded; any option left out keeps its default.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
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.

Header Parameters

Section titled “ Header Parameters ”
X-Olivares-Tenant
string format: uuid

Target tenant in explicit tenant mode.

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
digits
boolean
default: true
length
integer
default: 20 >= 8 <= 128
lower
boolean
default: true
symbols
boolean
default: true
upper
boolean
default: true

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
password
string format: password
Example generated 
{
  "password": "example"
}

400

Section titled “ 400 ”

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

401

Section titled “ 401 ”

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

403

Section titled “ 403 ”

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

404

Section titled “ 404 ”

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

409

Section titled “ 409 ”

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

429

Section titled “ 429 ”

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