Zum Hauptinhalt springen

Benutzerprofil erfassen

Cloud availabilityOSS availability

Über die Authentifizierungskennungen und Anmeldedaten hinaus, die für die Anmeldung des Benutzers erforderlich sind, muss deine Anwendung möglicherweise zusätzliche Benutzerprofilinformationen erfassen, die in Logto gespeichert werden, um sie einfach über JWT-Ansprüche (Claims) oder APIs abzurufen und personalisierte Produkterlebnisse zu bieten. Du kannst Benutzerdaten auf folgende Weise erfassen:

  • Während der Neuregistrierung eines Benutzers: Verwende die Funktion Benutzerprofil erfassen, um einen sofort einsatzbereiten Schritt „Erzähle uns etwas über dich“ hinzuzufügen, der während der Registrierung zusätzliche Benutzerprofilinformationen abfragt. Neue Benutzer müssen alle Pflichtfelder ausfüllen, bevor die Registrierung als abgeschlossen gilt. In diesem Dokument liegt der Fokus auf diesem Ansatz.

  • Nach der Benutzerregistrierung: Verwende die Account API, um Self-Service-Erfahrungen während Onboarding-Flows, im Account Center oder während der gesamten Produktnutzung zu implementieren, um Benutzerprofilinformationen zu aktualisieren.

Zentrale Vorteile

Die Funktion Benutzerprofil erfassen ermöglicht es dir, während der Registrierung von Endbenutzern zusätzliche Informationen zu sammeln. Wir empfehlen, nur die für dein Produkt unbedingt erforderlichen Informationen abzufragen, um lange Registrierungsprozesse zu vermeiden, die die Konversionsrate beeinträchtigen könnten.

Diese Funktion ermöglicht dir:

  • Umfassende Benutzerdaten erfassen: Sammle beliebige Benutzerdaten für geschäftliche oder Compliance-Zwecke, einschließlich OIDC-Standard-Benutzereigenschaften und benutzerdefinierter Daten.

  • Flexible Feldanpassung: Wähle aus verschiedenen Feldtypen wie Text, Zahl, Datum, Checkbox, Dropdown (Auswahl), URL und Regex-Validierung, um deine spezifischen Datenanforderungen zu erfüllen.

  • Optimierte Benutzererfahrung: Passe die Anzeige mit Labels, Beschreibungen, Platzhaltern und Validierungsregeln an. Konfiguriere Felder als erforderlich oder optional, je nach Geschäftsanforderung.

  • Vorkonfigurierte Feldeinstellungen: Nutze vorgefertigte Basisdatenfelder für gängige Benutzereigenschaften mit Plug-and-Play-Einrichtung. Verwende zusammengesetzte Felder (Adresse, vollständiger Name), um strukturierte Daten effizient in einem Schritt zu erfassen.

Schnellstart

  1. Gehe zu Logto-Konsole > Anmeldeerlebnis > Benutzerprofil erfassen.
  2. Klicke auf „Profilfelder hinzufügen“ und wähle ein vorgefertigtes Feld oder definiere benutzerdefinierte Daten (alphanumerischer Schlüssel) zum Erstellen aus.
  3. Öffne die Felddetails, um Feldtyp, Label, Beschreibung, Pflichtfeld-Flag und typspezifische Einstellungen (Länge, Bereich, Format, Optionen usw.) festzulegen. Klicke auf „Änderungen speichern“.
  4. Zurück im Bereich Anmeldeerlebnis > Benutzerprofil erfassen kannst du die Felder per Drag-and-drop neu anordnen; die Änderungen werden automatisch übernommen.
  5. Teste das Benutzererlebnis mit der Logto Live-Vorschau oder deiner Test-App. Egal, ob Benutzer ein neues Konto über Kennung (E-Mail / Telefonnummer / Benutzername), soziale Anmeldung oder Enterprise SSO erstellen, sie sehen während der Registrierung die Seite „Erzähle uns etwas über dich“.
Benutzerprofil während der Registrierung erfassen

Benutzerdatentypen

Benutzerdaten können in jedem Benutzerprofil eingesehen werden. Für einen umfassenden Überblick über alle Benutzerdatenkategorien siehe die Dokumentation zur Benutzerdatenstruktur. Mit der Funktion Benutzerprofil erfassen kannst du sowohl Basis-Benutzerdaten als auch benutzerdefinierte Benutzerdaten während der Registrierung erfassen.

Basis-Benutzerdatenfelder

Von Logto bereitgestellte Basis-Benutzerdatenfelder werden direkt in der Eigenschaft user oder user.profile gespeichert. Diese Felder verfügen über Standardkonfigurationswerte und i18n-Übersetzungen und sind sofort nach der Erstellung einsatzbereit. Du kannst Feldtypen und Parameter auch an deine spezifischen Anforderungen anpassen.

FeldnameBenutzerdaten-SchlüsselBeschreibung
Nameuser.nameDer vollständige Name des Benutzers in darstellbarer Form, einschließlich aller Namensbestandteile (z. B. „Jane Doe“).
Vollständiger Nameuser.profile.givenName
user.profile.middleName
user.profile.familyName
Der vollständige rechtliche Name des Benutzers. Kombiniert flexibel familyName, givenName und middleName je nach Konfiguration.
Spitznameuser.profile.nicknameUmgangssprachlicher oder vertrauter Name des Benutzers, der vom offiziellen Namen abweichen kann.
Geburtsdatumuser.profile.birthdateDas Geburtsdatum des Benutzers in einem angegebenen Format (z. B. „MM-dd-yyyy“).
Geschlechtuser.profile.genderDas selbst gewählte Geschlecht des Benutzers (z. B. „Weiblich“, „Männlich“, „Keine Angabe“).
Profiluser.profile.profileURL zur menschenlesbaren Profilseite des Benutzers (z. B. Social-Media-Profil).
Webseiteuser.profile.websiteURL zur persönlichen Webseite oder zum Blog des Benutzers.
Adresseuser.profile.address.formatted
user.profile.address.streetAddress
user.profile.address.region
user.profile.address.zoneinfo
user.profile.address.postalCode
user.profile.address.country
Die vollständige Adresse des Benutzers (z. B. „Musterstraße 123, Musterstadt, Deutschland 12345“). Wähle zwischen einzeilig (address.formatted) oder mehrzeilig mit konfigurierbaren Komponenten.

Benutzerdefinierte Benutzerdatenfelder

Benutzerdefinierte Benutzerdatenfelder sind selbst definierte Felder, die zusätzliche Informationen erfassen, die von den Basisfeldern nicht abgedeckt werden, wie Präferenzen, Interessen, Unternehmensgröße oder andere geschäftsspezifische Merkmale.

Beim Erstellen benutzerdefinierter Felder verwende nur alphanumerische Zeichen für den Benutzerdaten-Schlüssel (z. B. customData.companySize). Anschließend kannst du den Feldtyp konfigurieren und weitere Eigenschaften anpassen, um deine Anforderungen zu erfüllen.

Weitere Informationen zum Abrufen und Aktualisieren benutzerdefinierter Benutzerdaten nach der Benutzererstellung findest du unter Benutzerdatenstruktur.

Feldtypen

Wir können Felder einfach nach Einfachheit kategorisieren:

  • Primär: Text, Zahl, Datum, Checkbox (Boolean), Dropdown (Einzelauswahl), URL, Regulärer Ausdruck.
  • Zusammengesetzt: Vollständiger Name, Adresse.

Allgemeine Eigenschaften

EigenschaftGilt fürHinweise
LabelAlleAnzeigename für Benutzer. Schwebt nach oben, wenn das Feld Wert hat oder fokussiert ist. Pflichtfeld.
PlatzhalterAlle (außer Checkbox)Inline-Hinweis sichtbar, wenn das Label schwebt (Beispieltext / Formatierungshinweis).
BeschreibungAlle (außer Checkbox)Unterstützungstext unter dem Feld für längere Anweisungen oder zusätzlichen Kontext.
ErforderlichAlle (außer Checkbox)Wenn aktiviert, wird die Übermittlung bei Leere blockiert. Wenn deaktiviert, wird ein „(Optional)“-Tag angehängt.

Typspezifische Konfigurationen

TypKonfigurierbare AspekteHinweise
Textmin / max LängeBegrenze die minimale und maximale Länge des Benutzereingabetexts.
Zahlmin / max WertBegrenze den minimalen und maximalen Zahlenbereich des Eingabewerts.
DatumDatumsformat (vorgegeben / benutzerdefiniert)Wähle vorgegebene Formate (MM/dd/yyyy, dd/MM/yyyy, yyyy-MM-dd). Änderung des Platzhalters überschreibt Standardinteraktionen. Oder nutze vollständig anpassbare date-fns-Muster.
CheckboxStandardwertAktiviert (True) / Deaktiviert (False).
Dropdown (Auswahl)Optionsliste (≥1)Verwende Wert:Label pro Zeile. Wenn das Label weggelassen wird, wird der Wert angezeigt.
URLN/AN/A
RegexRegulärer AusdruckValidierungsmuster (ohne führende / abschließende Schrägstriche). Z. B. ^\d3-\d2-\d4$ für SSN.
AdresseKomponentenEin- oder mehrzeilig; Unterkomponenten: Straße, Stadt, Bundesland, Postleitzahl, Land.
Vollständiger NameKomponentenUnterkomponenten: Vorname, zweiter Vorname, Nachname.

Validierung

Die Feldvalidierung erfolgt bei der Benutzerübermittlung im letzten Schritt der Registrierung. Folgende Prüfungen werden durchgeführt:

  • Pflichtfeldprüfung (außer Checkbox).
  • Längenbegrenzung (Text).
  • Zahlenbereich (Zahl).
  • Musterabgleich (Regex, Datum mit Format, URL, Auswahloption).
  • URL-Struktur (einfache syntaktische Validierung, keine Erreichbarkeitsprüfung).

Dies gilt auch für die Unterkomponenten der beiden zusammengesetzten Felder: address und fullname. Die einzelnen Komponenten müssen ebenfalls die gleichen Validierungskriterien erfüllen.

Lokalisierung

Logto stellt systemweite Übersetzungen für die Basis-Benutzerdatenfelder wie firstName, lastName, gender und birthdate bereit. Die Labels dieser Felder sind in der Logto-Konsole konfigurierbar. Du kannst diese Labels überschreiben, indem du eigene Übersetzungen unter Logto > Anmeldeerlebnis > Inhalt bereitstellst.

Benutzerdefinierte Felder basieren vollständig auf den von dir bereitgestellten Labels, Platzhaltern und Beschreibungen. Für die Lokalisierung benutzerdefinierter Felder kannst du Übersetzungen mit Bring your UI umsetzen oder uns kontaktieren, um Feedback zu geben.

Management API (wichtige Endpunkte)

MethodeEndpunktZweck
GET/api/custom-profile-fieldsListet alle Felder auf.
GET/api/custom-profile-fields/:nameEinzelne Felddefinition nach Name abrufen.
POST/api/custom-profile-fieldsEin Feld erstellen.
POST/api/custom-profile-fields/batchMehrere Felder erstellen (≤20 pro Anfrage).
PUT/api/custom-profile-fields/:nameFeld nach Name und vollständigem Datensatz aktualisieren.
DELETE/api/custom-profile-fields/:nameEin Feld löschen.
POST/api/custom-profile-fields/properties/sie-orderReihenfolge der Felder im Anmeldeerlebnis aktualisieren.

Best Practices

  • Erfasse bei der Registrierung nur unbedingt notwendige Daten; optionale Informationen können später ergänzt werden.
  • Verwende zusammengesetzte Felder für strukturierte Daten (Adresse, vollständiger Name) für Konsistenz und Lokalisierung.
  • Gib klare Beispiele / Platzhalter für formatabhängige Felder (Regex, Datum, Zahlenbereiche) an.

FAQs

Erfassen die Profilfelder bestehende Benutzerdaten?

Nein, sie erfassen nur Informationen aus dem letzten Schritt der Neuregistrierung.

Was passiert, wenn ich ein Feld lösche? Werden die Benutzerdaten entfernt?

Nein, die bestehenden Benutzerdaten werden nicht entfernt. Es wird lediglich das Feld aus dem Registrierungsformular im Endbenutzererlebnis entfernt.

Kann ich das Land mit einer kontrollierten Liste statt eines normalen Textfelds erfassen?

Ja, du kannst die Komponente „Land“ auf ein „Dropdown (Einzelauswahl)“-Feld mit standardisierten Optionen umstellen.