Auth Modul bietet Authentifizierung und Autorisierung für Ihre Anwendung, einschließlich Benutzerverwaltung, Gruppenverwaltung, Benutzerregistrierung, Login und verwandte Funktionen. Es wird automatisch installiert, wenn das Projekt erstellt wird.
Der Standard-Admin-Benutzer-Login und das Passwort lauten wie folgt:
- Login: [email protected]
- Password: appmaster
Die Moduleinstellungen können auf folgende Weise konfiguriert werden:
- SignUp Groups: definiert die Liste der Gruppen, in denen sich der Benutzer anmelden kann;
- SignUp: ermöglicht es Benutzern, sich anzumelden und Konten in der Anwendung zu erhalten;
- Session timeout (minutes): definiert die Zeit, nach der die aktuelle Benutzersitzung beendet wird, wenn der Benutzer im Leerlauf ist; Voreinstellung 60 min;
- Failed login delay (in ms): definiert die Verzögerungszeit für Antworten nach fehlgeschlagenen Anmeldeversuchen; Standardwert 0ms;
- Email confirmation required active=true; : legt fest, ob der Benutzer die Anmeldung per E-Mail bestätigen muss;
- Signed-Up User Active active=true für jedes neu erstellte Benutzerobjekt, falls aktiviert;
- Groups Registerkarte ermöglicht die Erstellung und Konfiguration einer Liste von Benutzergruppen;
User und User Session Modelle werden automatisch erstellt, sobald das Auth-Modul installiert ist. Sie finden sie in der Data Design Registerkarte. Es ist nicht möglich, die Standardattribute dieser Modelle zu konfigurieren, aber es ist möglich, neue Attribute hinzuzufügen.
User, User Session und Auth Module bezogene BPs
Vorinstallierte Geschäftsprozesse in Bezug auf User und User Session Modelle sind wie folgt:
-
User Modell
- DB: Delete User: löscht das Objekt User aus der Datenbank auf der Grundlage seiner ID;
- DB: Update User Setzt alle Felder eines bestimmten Modellobjekts in der Datenbank zurück und aktualisiert sie mit den angegebenen Werten ( DB: Patch User muss verwendet werden, um nur die angegebenen Felder zu ändern und die anderen unverändert beizubehalten);
- DB: Create User: erstellt einen Datensatz in der Datenbank und gibt das User Modellobjekt zurück (es erfordert die Verwendung von Make User Block zum Erstellen User Modellobjekt entsprechend den Eingabefeldern zu erstellen);
- DB: Soft Delete User Aktualisiert DeletedAt Feld des ausgewählten User Modellobjekts, anstatt den ganzen Datensatz zu löschen, wie DB: Delete User tut;
- DB: Bulk Delete User Bulk-Löschen: löscht die Menge der User Modellobjekt-Datensätzen mit dem angegebenen IDs ( ids Array); failed_ids - ein Array von Benutzern IDs die nicht gelöscht werden sollen;
- DB: Patch User: aktualisiert ausgewählte Felder des User Modellobjekts in der Datenbank ( DB: Update User muss verwendet werden, um alle Felder zurückzusetzen);
- DB: Search User: findet ein oder mehrere User Modellobjekte in der Datenbank anhand ihrer Felder und gibt sie zurück;
- DB: GetOne User Findet das User Modellobjekt anhand seiner ID und gibt es zurück;
- Expand User Rückgabe: gibt alle Felder des ausgewählten User Modellobjekts zurück;
- Make User: erstellt das User Modellobjekts auf der Grundlage von Eingabefeldern (es ist erforderlich, die DB: Create User um den Datensatz in der Datenbank zu erstellen);
-
User Session
- DB: Delete User Session Löscht User Session Objekt aus der Datenbank auf der Grundlage seiner ID;
- DB: Update User Session Setzt alle Felder eines gegebenen Modellobjekts in der Datenbank zurück und aktualisiert sie mit gegebenen Werten ( DB: Patch User Session muss verwendet werden, um nur die angegebenen Felder zu ändern);
- DB: Create User Session: erstellt einen Datensatz in der Datenbank und gibt das User Session Modellobjekt zurück (es erfordert die Verwendung von Make User Session Block zum Erstellen User Modellobjekts entsprechend den Eingabefeldern);
- DB: Soft Delete User Session: aktualisiert DeletedAt Feld des ausgewählten User Session Modellobjekts;
- DB: Bulk Delete User Session Bulk löscht die Menge der User Session Modellobjekt-Datensätze mit dem angegebenen IDs ( ids Array); failed_ids array definiert die Menge von IDs die vom Löschvorgang ignoriert werden;
- DB: Patch User Session: aktualisiert ausgewählte Felder des User Session Modellobjekts in der Datenbank ( DB: Update User Session muss verwendet werden um alle Felder zurückzusetzen);
- DB: Search User Session Findet ein oder mehrere User Session Modellobjekte in der Datenbank anhand ihrer Felder und gibt sie zurück;
- DB: GetOne User Session Findet das User Session Modellobjekt anhand seiner ID und gibt es zurück;
- Expand User Session Rückgabe aller Felder des ausgewählten User Session Modellobjekts zurück;
- Make User Session: erstellt das User Session Modellobjekts auf der Grundlage von Eingabefeldern (es ist erforderlich, die DB: Create User Session um den Datensatz in der Datenbank zu erstellen);
-
Auth Module
- Auth: Generate Auth Token Erzeugt ein Berechtigungs-Token ( Auth Token) mit der angegebenen Länge;
- Auth: Registration: registriert einen neuen Benutzer;
- Auth: Authorization prüft, ob ein gegebener Auth Token existiert und gibt den damit verbundenen Benutzer zurück;
- Auth: Authentification: prüft Login und Passwort des Benutzers und gibt zurück Auth Token;
- Auth: Logout: Beendet die Sitzung des aktuellen Benutzers auf Basis der Auth Token;
- Auth: Get current user: gibt aktuelles User Modell-Objekt;
- Auth: Remove user from group: Entfernt einen Benutzer aus der ausgewählten Gruppe auf Basis seiner ID;
- Auth: Add user to group: fügt einen Benutzer zur ausgewählten Gruppe hinzu, basierend auf dessen ID;
- Auth: Hash Password Konvertiert Passwort-String in Hash;
- Auth: Restore Password Wiederherstellen des Passworts auf der Grundlage der Anmeldung des Benutzers;
- Auth: Change Password: ändert das Passwort des Benutzers;
- Auth: Probe Password: prüft die Verbindung zwischen Passwort und Hash;
Auth Module, User und User Session endpoints
Vorinstalliert Endpoints der Auth Module und User und User Session Modelle werden automatisch generiert, sobald das Projekt erstellt wird.
Auth Module
AnfragetypEndpointZugehöriger Geschäftsprozess
_/logout/Auth: Logout
/auth/Auth: Authentification
/register/Auth: Registration
/confirm/Auth: Get Current User
/user/change-password/Auth: Change Password
/user/restore-password/Auth: Restore Password
/user/profile/_Auth: Get Current User
Benutzer
AnfragetypEndpointZugehöriger Geschäftsprozess
_/user/:id/DB: Update User
/user/:id/DB: Delete User
/user/:id/DB: GetOne User
/user/DB: Search User
/user/:id/DB: Patch User
/user/_DB: Create User
User Session
Anfrage-TypEndpointZugehöriger Geschäftsprozess
_/user-session/:id/DB: Delete User Session
/user-session/:id/DB: GetOne User Session
/user-session/DB: Search User Session
/user-session/:id/DB: Patch User Session
/user-session/DB: Create User Session
/user-session/:id/_DB: Update User Session
Auth Token
Auth Token wird als Session-Token eines autorisierten Benutzers verwendet. Es ist möglich, die Interaktion mit dem Auth Token, in den Geschäftsprozessen der Web-Applikation zu interagieren:
- Get Auth Token gibt die aktuelle Sitzung des Benutzers zurück Auth Token;
- Set Auth Token schreibt die Sitzung des aktuellen Benutzers neu Auth Token;
- Remove Auth Token Entfernt die Sitzung des aktuellen Benutzers Auth Token;
Wie man den aktuellen Benutzer erhält
1. Gehen Sie zum Business logic und ziehen Sie den Auth: Get current user Block.
2. Gehen Sie zur Registerkarte Endpoints und erweitern Sie den User Abschnitt. Erstellen Sie dann eine GET Typmethode für den in Schritt 1 erstellten Geschäftsprozess. Die URL endpoint würde lauten /user_current.
3. Gehen Sie auf die Registerkarte Web Apps und erstellen Sie einen neuen Geschäftsprozess mit Server request GET /user_current um den aktuellen Benutzer aus dem Geschäftsprozess der Webanwendung zu holen.
