Skip to main content

AdaptiveMFARiskEventPayload

Package: @nauth-toolkit/core Type: Interface

Risk event payload used by adaptive MFA to describe the user, risk score, decision, and client context.

import { AdaptiveMFARiskEventPayload } from '@nauth-toolkit/nestjs';

Properties

PropertyTypeRequiredDescription
action'allow' | 'require_mfa' | 'block_signin'YesAction selected by risk evaluation.
authMethodstringYesAuthentication method (e.g., password, google).
clientInfoobjectYesClient context (IP, device, location, user agent).
metadataRecord<string, unknown>NoAdditional metadata.
riskFactorsstring[]YesRisk factor identifiers.
riskLevel'low' | 'medium' | 'high'YesRisk level classification.
riskScorenumberYesRisk score (0-100).
timestampDateYesTimestamp of the risk event.
userAdaptiveMFAUserYesUser being authenticated.

Used By