Skip to main content

login

Logs a user into their account by giving them an account token

Request Body

The information required to login

app string

The app that is logging in

username string — REQUIRED

The username of the account being logged in to

password string — REQUIRED

The password of the account

twofacode string

The 2FA code if needed

Responses
200

A successful request

Schema — OPTIONAL
success boolean

Was the operation a success

message string

The message returned by the server

result object — OPTIONAL

The result of the server response

LoginResult integer

The LoginResult. 0 - Incorrect, 1 - Missing2FA, 2 - Banned, 3 - Warned, 4 - Correct.

WarnStatus object — OPTIONAL

If present, then the user has received a warning. This should be displayed.

BanStatus object — OPTIONAL

If present, then the user has been banned. No token will be given and the ban note should be displayed.

token object — OPTIONAL

The created token to be used for authentication