AuthAuditEventStatus

Package: @nauth-toolkit/client Type: String Literal Union

Type representing the status of an audit event.

import { AuthAuditEventStatus } from '@nauth-toolkit/client';

type AuthAuditEventStatus = 'SUCCESS' | 'FAILURE' | 'INFO' | 'SUSPICIOUS';

Values

Value	Description	Use Case
SUCCESS	Operation completed successfully	Login success, MFA verified, password changed
FAILURE	Operation failed	Failed login, invalid MFA code, verification expired
INFO	Informational event	Token refresh, session created, settings updated
SUSPICIOUS	Suspicious activity detected	Multiple failed attempts, unusual location, risky behavior

Examples

Filtering by Status:

// Get all failed events
const failures = await client.getAuditHistory({
  eventStatus: 'FAILURE',
  page: 1,
  limit: 50,
});

// Get all suspicious activity
const suspicious = await client.getAuditHistory({
  eventStatus: 'SUSPICIOUS',
  page: 1,
  limit: 100,
});

Status Badge Component:

function getStatusBadgeClass(status: AuthAuditEventStatus): string {
  const classes: Record<AuthAuditEventStatus, string> = {
    SUCCESS: 'badge-success',
    FAILURE: 'badge-danger',
    INFO: 'badge-info',
    SUSPICIOUS: 'badge-warning',
  };

  return classes[status];
}

function getStatusIcon(status: AuthAuditEventStatus): string {
  const icons: Record<AuthAuditEventStatus, string> = {
    SUCCESS: 'fa-light fa-circle-check',
    FAILURE: 'fa-light fa-circle-xmark',
    INFO: 'fa-light fa-circle-info',
    SUSPICIOUS: 'fa-light fa-triangle-exclamation',
  };

  return icons[status];
}

Angular Template:

<span [class]="'status-badge ' + getStatusClass(event.eventStatus)"> {{ event.eventStatus }} </span>

TypeScript Type Guard:

function isSuspiciousEvent(event: AuthAuditEvent): boolean {
  return (
    event.eventStatus === 'SUSPICIOUS' || (event.eventStatus === 'FAILURE' && event.riskFactor && event.riskFactor > 70)
  );
}

// Alert on suspicious events
const history = await client.getAuditHistory({ page: 1, limit: 20 });
const suspiciousEvents = history.data.filter(isSuspiciousEvent);

if (suspiciousEvents.length > 0) {
  console.warn(`Found ${suspiciousEvents.length} suspicious events!`);
  suspiciousEvents.forEach((event) => {
    console.log(`${event.eventType} from ${event.ipAddress}`);
  });
}

Related Types

• AuthAuditEvent - Individual audit event with AuthAuditEventStatus property
• AuthAuditEventType - Event type enum
• AuditHistoryResponse - Paginated audit history

Used By

• AuthAuditEvent - eventStatus property uses AuthAuditEventStatus type
• NAuthClient.getAuditHistory() - Filter parameter accepts AuthAuditEventStatus values