Module BeginPassReset

Initiate a password reset. This call will trigger an email containing the passwordResetCode which must be provided to confirm the reset.

Index

Interfaces

Args

Type aliases

Variables

HTTP
Path

Functions

Interfaces

Args

Args:

username

username: string

Type aliases

Response

Response: MessageResponse

Result

Result: MessageResult

When successful, the message ought to say something like, "An email has been sent with a temporary 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:281
Type guard; only returns true for valid Args objects.

Parameters
- val: any
Returns boolean

newArgs

newArgs(): Args

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

Returns Args

Generated using TypeDoc