API Reference

Update a user

PUT /api/users/{id}

Superadmin can update any user (except self-delete). Admins can only update viewers. Superadmin role cannot be assigned via this endpoint.

Operation IDupdateUser

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Request body

This request body is required.

Content typeapplication/json

requestobject

3 properties

usernamestring

passwordstring

Minimum length: 8

rolestring

Allowed values: admin, viewer

Success response body

200User updated

User updated

Content typeapplication/json

responseobject

7 properties

idinteger

usernamestring

rolestring

Allowed values: superadmin, admin, viewer

totp_verifiedinteger

Allowed values: 0, 1

invite_pendingboolean

created_atstring · date-time

updated_atstring · date-time

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

403Insufficient permissions

Insufficient permissions

No response content schema is documented.

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request PUT \
  --url 'https://your-envoy.example.com/api/users/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "username": "string",
  "password": "string",
  "role": "admin"
}'

const response = await fetch("https://your-envoy.example.com/api/users/YOUR_ID", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "username": "string",
    "password": "string",
    "role": "admin"
  }),
});

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