Auth

Übersicht

Auth ist eine abstrakte Klasse für Benutzerauthentifizierungstypen. Sie definiert die Schnittstellen, die für eine vollständige Benutzerauthentifizierung erforderlich sind. Um einen neuen Benutzerauthentifizierungstyp zu erweitern, müssen Sie die Auth-Klasse erben und deren Methoden implementieren. Eine grundlegende Implementierung finden Sie unter: BaseAuth.

interface IAuth {
  user: Model;
  // Überprüft den Authentifizierungsstatus und gibt den aktuellen Benutzer zurück.
  check(): Promise<Model>;
  signIn(): Promise<any>;
  signUp(): Promise<any>;
  signOut(): Promise<any>;
}

export abstract class Auth implements IAuth {
  abstract user: Model;
  abstract check(): Promise<Model>;
  // ...
}

class CustomAuth extends Auth {
  // check: Authentifizierung
  async check() {
    // ...
  }
}

Instanzeigenschaften

user

Authentifizierte Benutzerinformationen.

Signatur

  • abstract user: Model

Klassenmethoden

constructor()

Konstruktor, erstellt eine Auth-Instanz.

Signatur

  • constructor(config: AuthConfig)

Typ

export type AuthConfig = {
  authenticator: Authenticator;
  options: {
    [key: string]: any;
  };
  ctx: Context;
};

Details

AuthConfig
EigenschaftTypBeschreibung
authenticatorAuthenticatorDas Authentifikator-Datenmodell. Der tatsächliche Typ in einer NocoBase-Anwendung ist AuthModel.
optionsRecord<string, any>Authentifikator-bezogene Konfiguration.
ctxContextAnfragekontext.

check()

Benutzerauthentifizierung. Gibt Benutzerinformationen zurück. Dies ist eine abstrakte Methode, die alle Authentifizierungstypen implementieren müssen.

Signatur

  • abstract check(): Promise<Model>

signIn()

Benutzeranmeldung.

Signatur

  • signIn(): Promise<any>

signUp()

Benutzerregistrierung.

Signatur

  • signUp(): Promise<any>

signOut()

Benutzerabmeldung.

Signatur

  • signOut(): Promise<any>