auth.login

Authenticate session using username and password. otp_token must be specified if two factor authentication is enabled.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: username

username

Type: string

Username for authentication.
Parameter 2: password

password

Type: string

Password for authentication.
Parameter 3: otp_token

otp_token

Default: null

One-time password token for two-factor authentication or null.

Type: string
Type: null

Result

Type: boolean

Returns true if login was successful, false otherwise.


Required roles: