API Reference

Initial user setup

View Markdown

POST /api/auth/setup

Creates the first superadmin user. Only works when no users exist.

Operation IDsetupAuth

Authentication

No authentication is required.

Request body

This request body is required.

Content typeapplication/json

requestobject

2 properties

usernamestringrequired

passwordstringrequired

Minimum length: 8

Success response body

200User created. When TOTP is required, returns TOTP enrollment data (`totp_secret`, `totp_uri`). When TOTP is disabled (`auth.totp_required: false`), returns `{ success: true }` and the caller proceeds to log in with the password only.

User created. When TOTP is required, returns TOTP enrollment data (totp_secret, totp_uri). When TOTP is disabled (auth.totp_required: false), returns { success: true } and the caller proceeds to log in with the password only.

Content typeapplication/json

responseobject

3 properties

totp_secretstring

totp_uristring

successboolean

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/auth/setup' \
  --header 'Content-Type: application/json' \
  --data '{
  "username": "string",
  "password": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/auth/setup", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "username": "string",
    "password": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);