Data types and enums

This page defines the shared types used in Blazeauth WebSocket payloads.

Packet id (`id`)

The server echoes id back in the response payload so you can correlate responses with requests.

Recommendations:

Use a monotonically increasing integer per connection (1, 2, 3...).
In JavaScript clients, keep id within the safe integer range (<= 9007199254740991).

credentials_type is an integer enum used by account endpoints.

Value	Meaning
`0`	login/password
`1`	email/password

When credentials_type = 1, the login field must be a valid email address.

levels is a JSON array of strings:

Levels payload

levels is always a JSON array of strings.

You can interpret levels as tags/roles that control access in your application.

Most responses include a status integer.

1 means OK.
other values represent specific outcomes (invalid license, not authorized, etc.).

See Status codes for the full list.

time_left is not identical across all endpoints.

get_current_license: time_left is seconds remaining until expiration.
auth_by_license: time_left is intended to be seconds remaining, but when a license is activated inside the same call it can be returned as an absolute Unix timestamp. See the note in that endpoint.

auth_by_credentials and get_current_account: time_left is an absolute Unix timestamp (seconds since epoch, UTC) representing when the account's license/subscription access ends.

If you are writing a shared client, treat time_left as endpoint-specific and normalize it into your own expires_at/seconds_remaining model.

Panel events are server-push messages with:

See Panel events for the event type list.