Module ConfirmPassReset

Conclude a password reset by supplying the code from the email along with a new password.

Index

Interfaces

Args

Type aliases

Variables

HTTP
Path

Functions

Interfaces

Args

Args:

newPassword

newPassword: string

passwordResetCode

passwordResetCode: string

username

username: string

Type aliases

Response

Response: MessageResponse

Result

Result: MessageResult

Ought to tell them they can now log in with their new password.

Variables

Const HTTP

HTTP: POST = "POST"

Const Path

Path: string = `${authBasePath}/${ResourcePaths.passReset}`

Functions

isArgs

isArgs(val: any): boolean

- Defined in spec/methods/auth/auth.ts:324
Type guard; only returns true for valid Args objects.

Parameters
- val: any
Returns boolean

newArgs

newArgs(): Args

- Defined in spec/methods/auth/auth.ts:333
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.

Returns Args

Generated using TypeDoc