Class MfaRequiredError

Error thrown when the token exchange results in a mfa_required error

Hierarchy (view full)

GenericError
- MfaRequiredError

Index

Constructors

Properties

data? error error_description mfa_requirements mfa_token

Methods

Constructors

constructor

new MfaRequiredError(error, error_description, mfa_token, mfa_requirements): MfaRequiredError
Parameters
- error: string
- error_description: string
- mfa_token: string
- mfa_requirements: MfaRequirements
Returns MfaRequiredError
Overrides GenericError.constructor
- Defined in src/errors.ts:155

Properties

`Optional` data

data?: Record<string, any>

Any other fields from the server's error response (for example auth_session).

error

error: string

The error code from the server response.

error_description

error_description: string

The error_description from the server response.

mfa_requirements

mfa_requirements: MfaRequirements

mfa_token

mfa_token: string

Methods

`Static` fromPayload

fromPayload(__namedParameters): GenericError
Parameters
- __namedParameters: {
  error: string;
  error_description: string;
  }
  - error: string
  - error_description: string
Returns GenericError
Inherited from GenericError.fromPayload
- Defined in src/errors.ts:33