Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Grant admin

POST
/api/v1/instance/admins
curl --request POST \
  --url https://example.com/api/v1/instance/admins \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "confirmation": "example", "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

An existing, active, unsuspended account, its email typed to confirm – it sees every account of the deployment once it enrolls TOTP. 409 INSTANCE_ADMIN_WEB_GRANTS_DISABLED when the deployment leaves it to the console.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
InstanceAdminGrantRequest
object
confirmation
required
Confirmation
string
>= 1 characters <= 255 characters
user_id
required
User Id
string format: uuid

Example generated

{
  "confirmation": "example",
  "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
InstanceAdminListResponse
object
items
required
Items
Array<object>
InstanceAdminRead
object
created_at
required
Created At
string format: date-time
email
required
Email
string
full_name
required
Full Name
string
last_login_at
required
Any of:
string format: date-time
suspended_at
required
Any of:
string format: date-time
user_id
required
User Id
string format: uuid
web_grants_enabled
required
Web Grants Enabled
boolean

Example generated

{
  "items": [
    {
      "created_at": "2026-04-15T12:00:00Z",
      "email": "example",
      "full_name": "example",
      "last_login_at": "2026-04-15T12:00:00Z",
      "suspended_at": "2026-04-15T12:00:00Z",
      "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "web_grants_enabled": true
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}