logologo
Start
Handbuch
Entwicklung
Plugins
API
Startseite
English
简体中文
日本語
한국어
Español
Português
Deutsch
Français
Русский
Start
Handbuch
Entwicklung
Plugins
API
Startseite
logologo
API-Überblick

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cache

CacheManager
Cache

@nocobase/cli

NocoBase CLI
Globale Umgebungsvariablen

@nocobase/client

Anwendung
Plugin

@nocobase/database

Sammlung
Feld

interfaces

BaseInterface
Filter-Operatoren

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
Repository

shared

create-options
destroy-options
find-one
find-options
transaction
update-options

@nocobase/data-source-manager

DataSourceManager
Datenquelle (abstrakt)
ICollectionManager
ICollection
IField
IModel
IRepository

@nocobase/flow-engine

DataSourceManager
FlowContext
FlowEngine
FlowModel
Workflow-Ressource

@nocobase/logger

Logger

@nocobase/server

AppCommand
Anwendung
AuditManager
Kontext
Migration
Plugin

@nocobase/sdk

Auth
Speicher
Previous PageAnwendung
Next PageKontext
KI-Übersetzungshinweis

Diese Dokumentation wurde automatisch von KI übersetzt.

#AuditManager

#Übersicht

AuditManager ist das Modul zur Ressourcen-Audit-Verwaltung in NocoBase. Es dient dazu, Ressourcen-Schnittstellen zu registrieren, die auditiert werden sollen.

#Grundlegende Verwendung

import { Plugin } from '@nocobase/server';

class PluginCustomAuditResourceServer extends Plugin {
  async load() {
    this.app.auditManager.registerAction('resource:action');
  }
}

#Klassenmethoden

#setLogger()

Legt die Ausgabemethode für Audit-Logs fest.

const auditManager = new AuditManager();
auditManager.setLogger({
  log: async (auditLog: AuditLog) => console.log(auditLog);
})

#Signatur

  • setLogger(logger: AuditLogger)

#Typ

export interface AuditLog {
  uuid: string;
  dataSource: string;
  resource: string;
  action: string;
  sourceCollection?: string;
  sourceRecordUK?: string;
  targetCollection?: string;
  targetRecordUK?: string;
  userId: string;
  roleName: string;
  ip: string;
  ua: string;
  status: number;
  metadata?: Record<string, any>;
}

export interface AuditLogger {
  log(auditLog: AuditLog): Promise<void>;
}

#registerAction()

Registriert eine Ressourcen-Aktion, die auditiert werden soll.

#Signatur

  • registerAction(action: Action)

#Typ

export interface UserInfo {
  userId?: string;
  roleName?: string;
}

export interface SourceAndTarget {
  sourceCollection?: string;
  sourceRecordUK?: string;
  targetCollection?: string;
  targetRecordUK?: string;
}

type Action =
  | string
  | {
      name: string;
      getMetaData?: (ctx: Context) => Promise<Record<string, any>>;
      getUserInfo?: (ctx: Context) => Promise<UserInfo>;
      getSourceAndTarget?: (ctx: Context) => Promise<SourceAndTarget>;
    };

#Details

Es werden verschiedene Schreibweisen unterstützt:

  1. Gilt für alle Ressourcen
registerActions(['create']);
  1. Gilt für alle Aktionen einer bestimmten Ressource resource:*
registerActions(['app:*']);
  1. Gilt für eine bestimmte Aktion einer bestimmten Ressource resource:action
registerAction(['pm:update']);
  1. Unterstützt die Übergabe benutzerdefinierter getMetaData-, getUserInfo- und getSourceAndTarget-Methoden für die Aktion.
registerActions([
  'create',
  { name: 'auth:signIn', getMetaData, getUserInfo, getSourceAndTarget },
]);

Wenn sich registrierte Schnittstellen überschneiden, hat die spezifischere Registrierungsmethode eine höhere Priorität. Zum Beispiel:

  1. registerActions('create')

  2. registerAction({ name: 'user:*', getMetaData })

  3. registerAction({ name: 'user:create', getMetaData })

Für die Schnittstelle user:create tritt 3 in Kraft.

#registerActions()

Registriert mehrere Ressourcen-Aktionen, die auditiert werden sollen.

#Signatur

  • registerActions(actions: Action[])