LoginPayloadOptions

Options for performing login operations

Example

export interface LoginOptions {
  /** The username/email to login with */
  username: string;
  /** The password for authentication */
  password: string;
  /** Optional captcha value if required */
  captcha?: string;
  /** Any additional custom options */
  [key: string]: string | number | boolean | undefined;
}

Indexable

[key: string]: string | number | boolean | undefined

Any additional custom options

Properties

captcha? · string

Optional captcha value if required

password · string

The password for authentication

username · string

The username/email to login with