AdaptiveMFARiskEventPayload
Package: @nauth-toolkit/core
Type: Interface
Risk event payload used by adaptive MFA to describe the user, risk score, decision, and client context.
- NestJS
- Express
- Fastify
import { AdaptiveMFARiskEventPayload } from '@nauth-toolkit/nestjs';
import { AdaptiveMFARiskEventPayload } from '@nauth-toolkit/core';
import { AdaptiveMFARiskEventPayload } from '@nauth-toolkit/core';
Properties
| Property | Type | Required | Description |
|---|---|---|---|
action | 'allow' | 'require_mfa' | 'block_signin' | Yes | Action selected by risk evaluation. |
authMethod | string | Yes | Authentication method (e.g., password, google). |
clientInfo | object | Yes | Client context (IP, device, location, user agent). |
metadata | Record<string, unknown> | No | Additional metadata. |
riskFactors | string[] | Yes | Risk factor identifiers. |
riskLevel | 'low' | 'medium' | 'high' | Yes | Risk level classification. |
riskScore | number | Yes | Risk score (0-100). |
timestamp | Date | Yes | Timestamp of the risk event. |
user | AdaptiveMFAUser | Yes | User being authenticated. |
Used By
- AdaptiveMFAUser -
userproperty type - NAuthConfig - Referenced by adaptive MFA configuration and hooks