Skip to main content
POST
Authenticate a player

Authorizations

Authorization
string
header
required

Player access token returned by login/refresh.

Body

application/json
identifier
string
required

Player email address or handle.

Example:

"player@example.com"

password
string
required

Player password.

Example:

"********"

oneClick
boolean

Request a one-click style login session where supported.

device_id
string

Caller-supplied device identifier (also sent as the x-device-id header).

device_name
string

Human-readable device name.

device_os
string

Device operating system name.

location
string

Free-form location string reported by the client.

Response

Successful credential exchange.

accessToken
string
required

Bearer access token.

refreshToken
string
required

Refresh token for /auth/validate rotation.

expiresIn
integer<int64>
required

Access-token lifetime in seconds.

Example:

3600

user
object
required

Backend user object.

message
string

Optional backend message (for example "Login successful").

requiresOTP
boolean
default:false

Whether the backend requires further OTP verification. The SDK surfaces an error when true.

Last modified on September 10, 2026