Class User

constructor

• new User(userClient: UserClient, userProps: RawUser): User

  Parameters

  • userClient: UserClient
  • userProps: RawUser

  Returns User

Readonlyadmin

email

Readonlyfirst_name

Readonlyid

Readonlylanguage

Readonlylast_name

Readonlyusername

createApiKey

• createApiKey(builder: ApiKeyBuilder): Promise<ApiKey>

  Create a new api key for this account

  Parameters

  • builder: ApiKeyBuilder

  Returns Promise<ApiKey>

disableMfa

• disableMfa(password: string): Promise<void>

  Disable the mfs/2fa for this account

  Parameters

  • password: string

    The account password

  Returns Promise<void>

  Throws

  Invalid password error

enableMfa

• enableMfa(code: number, password: string): Promise<RecoveryTokensAttributes>

  Enable the mfa/2fa for this account

  Parameters

  • code: number

    The 6 digit code generated from the mfs secret (via 'getMfaCredentials()')

  • password: string

    The account password

  Returns Promise<RecoveryTokensAttributes>

  Throws

  Invalid code error

getApiKeys

• getApiKeys(): Promise<ApiKey[]>

  Get the api keys for this account

  Returns Promise<ApiKey[]>

getMfaCredentials

• getMfaCredentials(): Promise<{ image_url_data: string; secret: string }>

  Get the users mfa/2fa credentials to generate the auth codes

  Returns Promise<{ image_url_data: string; secret: string }>

updateEmail

• updateEmail(email: string, password: string): Promise<void>

  Update this accounts email address

  Parameters

  • email: string

    A valid new email address

  • password: string

    The account password

  Returns Promise<void>

  Throws

  Invalid email and/or password error

updatePassword

• updatePassword(
      oldPassword: string,
      newPassword: string,
      repeatPassword?: string,
  ): Promise<void>

  Updates this accounts password

  Parameters

  • oldPassword: string

    The old password for this account

  • newPassword: string
  • OptionalrepeatPassword: string

  Returns Promise<void>