Interface AccountsModule

Hierarchy

  • AccountsModule

Properties

addEmail buildTOTPSecret changePassword createHashLoginToken createImpersonationToken createLoginToken createUser dbManager disableTOTP emit enableTOTP findUnverifiedUserByToken findUserByEmail findUserByUsername getAccountsServer loginWithService logout removeEmail resetPassword sendEnrollmentEmail sendResetPasswordEmail sendVerificationEmail setPassword setUsername verifyEmail

Properties

addEmail

addEmail: ((userId: string, email: string) => Promise<void>)

Type declaration

    • (userId: string, email: string): Promise<void>

    • Parameters

      • userId: string
      • email: string

      Returns Promise<void>

buildTOTPSecret

buildTOTPSecret: (() => string)

Type declaration

    • (): string

    • Returns string

changePassword

changePassword: ((userId: string, params: { newPassword?: string; newPlainPassword?: string; oldPassword?: string; oldPlainPassword?: string }) => Promise<boolean>)

Type declaration

    • (userId: string, params: { newPassword?: string; newPlainPassword?: string; oldPassword?: string; oldPlainPassword?: string }): Promise<boolean>

    • Parameters

      • userId: string
      • params: { newPassword?: string; newPlainPassword?: string; oldPassword?: string; oldPlainPassword?: string }
        • Optional newPassword?: string
        • Optional newPlainPassword?: string
        • Optional oldPassword?: string
        • Optional oldPlainPassword?: string

      Returns Promise<boolean>

createHashLoginToken

createHashLoginToken: ((loginToken: string) => string)

Type declaration

    • (loginToken: string): string

    • Parameters

      • loginToken: string

      Returns string

createImpersonationToken

createImpersonationToken: ((userId: string, context: Context) => Promise<{ id: string; token: string; tokenExpires: Date }>)

Type declaration

    • (userId: string, context: Context): Promise<{ id: string; token: string; tokenExpires: Date }>

    • Parameters

      Returns Promise<{ id: string; token: string; tokenExpires: Date }>

createLoginToken

createLoginToken: ((userId: string, context: Context) => Promise<{ id: string; token: string; tokenExpires: Date }>)

Type declaration

    • (userId: string, context: Context): Promise<{ id: string; token: string; tokenExpires: Date }>

    • Parameters

      Returns Promise<{ id: string; token: string; tokenExpires: Date }>

createUser

createUser: ((userData: UserData, options: { skipMessaging?: boolean }) => Promise<string>)

Type declaration

    • (userData: UserData, options: { skipMessaging?: boolean }): Promise<string>

    • Parameters

      • userData: UserData
      • options: { skipMessaging?: boolean }
        • Optional skipMessaging?: boolean

      Returns Promise<string>

dbManager

dbManager: any

disableTOTP

disableTOTP: ((userId: string, code: string) => Promise<boolean>)

Type declaration

    • (userId: string, code: string): Promise<boolean>

    • Parameters

      • userId: string
      • code: string

      Returns Promise<boolean>

emit

emit: ((event: string, meta: any) => Promise<void>)

Type declaration

    • (event: string, meta: any): Promise<void>

    • Parameters

      • event: string
      • meta: any

      Returns Promise<void>

enableTOTP

enableTOTP: ((userId: string, secret: string, code: string) => Promise<boolean>)

Type declaration

    • (userId: string, secret: string, code: string): Promise<boolean>

    • Parameters

      • userId: string
      • secret: string
      • code: string

      Returns Promise<boolean>

findUnverifiedUserByToken

findUnverifiedUserByToken: ((token: string) => Promise<User>)

Type declaration

    • (token: string): Promise<User>

    • Parameters

      • token: string

      Returns Promise<User>

findUserByEmail

findUserByEmail: ((email: string) => Promise<User>)

Type declaration

    • (email: string): Promise<User>

    • Parameters

      • email: string

      Returns Promise<User>

findUserByUsername

findUserByUsername: ((username: string) => Promise<User>)

Type declaration

    • (username: string): Promise<User>

    • Parameters

      • username: string

      Returns Promise<User>

getAccountsServer

getAccountsServer: (() => any)

Type declaration

    • (): any

    • Returns any

loginWithService

loginWithService: ((params: { service: "guest" } | { code?: string; password: string; service: "password"; user: { email: string } | { username: string } }, context: Context) => Promise<{ id: string; token: string; tokenExpires: Date }>)

Type declaration

    • (params: { service: "guest" } | { code?: string; password: string; service: "password"; user: { email: string } | { username: string } }, context: Context): Promise<{ id: string; token: string; tokenExpires: Date }>

    • Parameters

      • params: { service: "guest" } | { code?: string; password: string; service: "password"; user: { email: string } | { username: string } }
      • context: Context

      Returns Promise<{ id: string; token: string; tokenExpires: Date }>

logout

logout: ((params: { token?: string }, context: Context) => Promise<{ error: any; success: boolean }>)

Type declaration

    • (params: { token?: string }, context: Context): Promise<{ error: any; success: boolean }>

    • Parameters

      • params: { token?: string }
        • Optional token?: string
      • context: Context

      Returns Promise<{ error: any; success: boolean }>

removeEmail

removeEmail: ((userId: string, email: string) => Promise<void>)

Type declaration

    • (userId: string, email: string): Promise<void>

    • Parameters

      • userId: string
      • email: string

      Returns Promise<void>

resetPassword

resetPassword: ((params: { newPassword?: string; newPlainPassword?: string; token: string }, context: Context) => Promise<User>)

Type declaration

    • (params: { newPassword?: string; newPlainPassword?: string; token: string }, context: Context): Promise<User>

    • Parameters

      • params: { newPassword?: string; newPlainPassword?: string; token: string }
        • Optional newPassword?: string
        • Optional newPlainPassword?: string
        • token: string
      • context: Context

      Returns Promise<User>

sendEnrollmentEmail

sendEnrollmentEmail: ((email: string) => Promise<void>)

Type declaration

    • (email: string): Promise<void>

    • Parameters

      • email: string

      Returns Promise<void>

sendResetPasswordEmail

sendResetPasswordEmail: ((email: string) => Promise<boolean>)

Type declaration

    • (email: string): Promise<boolean>

    • Parameters

      • email: string

      Returns Promise<boolean>

sendVerificationEmail

sendVerificationEmail: ((email: string) => Promise<void>)

Type declaration

    • (email: string): Promise<void>

    • Parameters

      • email: string

      Returns Promise<void>

setPassword

setPassword: ((userId: string, params: { newPassword?: string; newPlainPassword?: string }) => Promise<void>)

Type declaration

    • (userId: string, params: { newPassword?: string; newPlainPassword?: string }): Promise<void>

    • Parameters

      • userId: string
      • params: { newPassword?: string; newPlainPassword?: string }
        • Optional newPassword?: string
        • Optional newPlainPassword?: string

      Returns Promise<void>

setUsername

setUsername: ((userId: string, username: string) => Promise<void>)

Type declaration

    • (userId: string, username: string): Promise<void>

    • Parameters

      • userId: string
      • username: string

      Returns Promise<void>

verifyEmail

verifyEmail: ((token: string) => Promise<void>)

Type declaration

    • (token: string): Promise<void>

    • Parameters

      • token: string

      Returns Promise<void>

Settings

Member Visibility

Theme