AuthenticationSettings | WebHare Platform SDK

Class AuthenticationSettings

Index

Constructors

Methods

getLastPasswordChange getNumPasswords hasTOTP isPasswordStillSecure isUsedSince toHSON updatePassword verifyPassword fromHSON fromPasswordHash

Constructors

constructor

new AuthenticationSettings(): AuthenticationSettings
Returns AuthenticationSettings

Methods

getLastPasswordChange

getLastPasswordChange(): null | Instant
Returns null | Instant
- Defined in jssdk/wrd/src/authsettings.ts:81

getNumPasswords

getNumPasswords(): number
Returns number
- Defined in jssdk/wrd/src/authsettings.ts:89

hasTOTP

hasTOTP(): boolean
Returns boolean
- Defined in jssdk/wrd/src/authsettings.ts:77

isPasswordStillSecure

isPasswordStillSecure(): boolean
Returns boolean
- Defined in jssdk/wrd/src/authsettings.ts:85

isUsedSince

isUsedSince(password: string, cutoff: Instant): Promise<boolean>
Parameters
- password: string
- cutoff: Instant
Returns Promise<boolean>
- Defined in jssdk/wrd/src/authsettings.ts:128

toHSON

toHSON(): string
Returns string
- Defined in jssdk/wrd/src/authsettings.ts:62

updatePassword

updatePassword(
password: string,
options?: { algorithm?: "PLAIN" | "WHBF"; inPlace?: boolean },
): Promise<void>
Update the password in this setting
Parameters
- password: string
  The new password
- Optionaloptions: { algorithm?: "PLAIN" | "WHBF"; inPlace?: boolean }
Returns Promise<void>
- Defined in jssdk/wrd/src/authsettings.ts:98

verifyPassword

verifyPassword(password: string): Promise<boolean>
Parameters
- password: string
Returns Promise<boolean>
- Defined in jssdk/wrd/src/authsettings.ts:117

`Static`fromHSON

fromHSON(hson: string): AuthenticationSettings
Parameters
- hson: string
Returns AuthenticationSettings
- Defined in jssdk/wrd/src/authsettings.ts:34

`Static`fromPasswordHash

fromPasswordHash(hash: string): AuthenticationSettings
Parameters
- hash: string
Returns AuthenticationSettings
- Defined in jssdk/wrd/src/authsettings.ts:27