Module SetMfaPreference

Sets user MFA preferences

Index

Interfaces

Args

Type aliases

Variables

HTTP
Path

Functions

Interfaces

Args

Args:

mfaEnabled

mfaEnabled: boolean

Optional preferredMfa

preferredMfa: MfaTypes

Type aliases

Response

Response: ApiResponse<Result>

Result

Result: object

Returns which MFA method (if any) is enabled

Type declaration

Optional enabledMfa?: MfaTypes

Variables

Const HTTP

HTTP: POST = "POST"

Const Path

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

Functions

isArgs

isArgs(val: any): boolean

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

Parameters
- val: any
Returns boolean

newArgs

newArgs(): Args

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

Returns Args

Generated using TypeDoc