blazeauth
Protocol

Usecase types

Numeric operation identifiers used in the WebSocket protocol.

Usecase types

Every request includes a numeric type field (see Message format).

TypeNameDescription
0pingMeasure connection RTT and check that the session is alive.
1initializeBind the session to an application using socket_api_key and client_id.
2create_accountCreate a new application account (login/password or email/password).
3auth_by_licenseAuthorize the session using a license key.
4auth_by_credentialsAuthorize the session using login/password (optionally also activating a license).
5link_license_to_accountLink a license key to the currently authorized account and activate it.
6logoutDrop the current authorization state.
7blacklistBlacklist the current client id and optionally the current license/account.
8transfer_fileStart a protected file stream.
9stop_file_transferStop an active file stream (optionally issuing a resume token).
10resume_file_transferResume a file stream using a resume token.
11get_file_metadataGet file size/checksum and transfer statistics.
12get_online_users_countGet currently connected sessions count for the application.
13get_variableRead an application variable (optionally requiring authorization).
14set_session_valueStore a key/value inside the current session with TTL.
15get_session_valueRead a key/value from the current session.
16get_current_licenseRead the currently authorized license (license auth only).
17get_current_accountRead the currently authorized account (credentials auth only).
18panel_event_subscribeReserved for panel event subscription (currently a no-op).

You can find full request/response schemas in the API reference.

On this page