blazeauth
Reference

auth_by_credentials

Authorize the session using login/password or email/password.

auth_by_credentials

Authorize the current WebSocket session using a credentials account.

  • Type: 4
  • Requires initialization: yes
  • Requires authorization: no

Request and response example

auth_by_credentials
Authorize a session using login/password or email/password.

Request fields

FieldTypeRequiredMeaning
iduint64yesRequest id.
loginstringyesLogin or email (depends on credentials_type).
passwordstringyesPlain password.
licensestring | nullnoOptional license key to activate during auth.
credentials_typeintyes0 = login/password, 1 = email/password.

Response fields (success)

FieldTypeMeaning
iduint64Your request id.
loginstringAccount login.
levelsstring[]Account levels/tags.
commentstring | nullOptional internal note.
ip_addressstring | nullIP stored for this account.
time_leftint64Absolute Unix timestamp (UTC) when access ends, if license-required.
license_requiredboolWhether the account requires a valid license/subscription.
statusintResult status.

Common statuses

StatusMeaning
1ok
3not_authorized (returned by other endpoints, not this one)
202account_not_found
203account_has_no_valid_licenses
210account_blacklisted
303sessions_quota_exceeded
216account_credentials_type_invalid
6internal_server_error

Notes

  • If license_required = true, the server expects the user to have at least one active license/subscription in Blazeauth.
  • If you pass license and activation succeeds, the license becomes bound to the current client_id.

On this page