Interface AuthLogin

AuthLogin

interface AuthLogin {
    apiKey: string;
    email: string;
    mfaEnabled: boolean;
    mfaKey: string;
    name: string;
}

Properties

apiKey: string

If MFA is not enabled, the api key is returned right away.

AuthLogin

email: string

Email address

AuthLogin

mfaEnabled: boolean

AuthLogin

mfaKey: string

Only useful when user enables MFA. In this case, user needs to enter their OTP token in order to login.

AuthLogin

name: string

User's name, could be an empty string.

AuthLogin