Schemas

Site

id

string

org_id

string

name

string

topic_prefixes

string[]

Principal

sub

string · required

org_id

string · required

role

string · enum · required

Enum values:

admin

operator

viewer

service

site_ids

string[]

kind

string · enum

Enum values:

session

api_key

email

string | null

The login's email; null for an API key.

display_name

string | null

How the login signs (set by an admin); null when unset or for an API key.

ApiKey

id

string · required

org_id

string · required

role

string · required

site_ids

string[]

expires_at

string | null · date-time

revoked_at

string | null · date-time

created_at

string · date-time

last_used_at

string | null · date-time

BrokerAccount

id

string · required

site_id

string · required

username

string · required

created_at

string · date-time · required

description

string | null

rotated_at

string | null · date-time

BrokerConnect

Where an edge node connects (BALER_MQTT_PUBLIC_* in .env).

host

string | null

port

integer

tls_port

integer | null

BrokerAccountSecret

BrokerAccount · required

password

string · required

Shown once.

BrokerConnect

Where an edge node connects (BALER_MQTT_PUBLIC_* in .env).

Error

error

string · required

Baler Auth API

Schemas

Site

id

string

org_id

string

name

string

topic_prefixes

string[]

Principal

sub

string · required

org_id

string · required

role

string · enum · required

Enum values:

admin

operator

viewer

service

site_ids

string[]

kind

string · enum

Enum values:

session

api_key

email

string | null

The login's email; null for an API key.

display_name

string | null

How the login signs (set by an admin); null when unset or for an API key.

ApiKey

id

string · required

org_id

string · required

role

string · required

site_ids

string[]

expires_at

string | null · date-time

revoked_at

string | null · date-time

created_at

string · date-time

last_used_at

string | null · date-time

BrokerAccount

id

string · required

site_id

string · required

username

string · required

created_at

string · date-time · required

description

string | null

rotated_at

string | null · date-time

BrokerConnect

Where an edge node connects (BALER_MQTT_PUBLIC_* in .env).

host

string | null

port

integer

tls_port

integer | null

BrokerAccountSecret

BrokerAccount · required

password

string · required

Shown once.

BrokerConnect

Where an edge node connects (BALER_MQTT_PUBLIC_* in .env).

Error

error

string · required