Ihr Profil abrufen

GET /fapi/v1/me · wird vom Anmelde-Host der Umgebung aufgerufen

Gibt das eigene Profil des authentifizierten Benutzers zurück: die sieben Felder, die der Benutzer ändern kann, sowie user_metadata. Kontaktdaten, Verifizierungsstatus, app_metadata und administrative Felder werden nicht zurückgegeben. Der Header ETag ist die Profilversion; senden Sie ihn in If-Match, damit eine Änderung nur bei passender Version erfolgt. Erforderlich ist der Cookie __Host-idp_session des authentifizierten Benutzers; fehlt der Cookie, ist er abgelaufen oder widerrufen, wird 401 unauthenticated zurückgegeben. Eine First-Party-Anwendung auf einem anderen Ursprung kann stattdessen ihr Front-API-Zugriffstoken senden (Authorization: DPoP <token> mit einem DPoP-Nachweis; siehe Front-API-Zugriffstoken). Eine erneute Verifizierung ist nicht erforderlich. Die Antwort enthält personenbezogene Daten und wird niemals zwischengespeichert.

Anfrage

Header:

Header Erforderlich Beschreibung
Idp-Client ja SDK-Kennung.

Kein Body.

Antwort

200 OK mit einem Header ETag (die Profilversion, zum Beispiel "8"):

Feld Typ Beschreibung
id string Benutzerkennung (usr_…), dieselbe wie sub in den Token.
given_name string Vorname.
family_name string Nachname.
name string Vollständiger Name.
picture string URL des Profilbilds (https).
locale string Sprache (BCP-47-Tag).
zoneinfo string Zeitzone (IANA-Name).
username string Benutzername.
user_metadata object Eigene Metadaten des Benutzers; immer ein JSON-Objekt ({}, wenn leer).

Felder ohne Wert fehlen in der Antwort.

{
  "id": "usr_01jbz6x8kq3m2n4p5r6s7t8v9w",
  "given_name": "Ada",
  "family_name": "Lovelace",
  "name": "Ada Lovelace",
  "locale": "en-GB",
  "zoneinfo": "Europe/London",
  "username": "ada",
  "user_metadata": {
    "theme": "dark"
  }
}

Fehler

Status Code Wann
401 unauthenticated Kein gültiger Sitzungs-Cookie.
404 not_found Das Konto kann nicht gelesen werden (zum Beispiel gesperrt oder in Löschung).
503 service_unavailable Das Benutzerverzeichnis ist vorübergehend nicht verfügbar; erneut versuchen nach Retry-After Sekunden.

Beispiel

curl https://example.keenauth.app/fapi/v1/me \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -b cookies.txt

Personenbezogene Daten

Dieser Endpunkt verarbeitet personenbezogene Daten: Profil des Endbenutzers. Personenbezogene Daten in den KeenAuth-APIs beschreibt, was gespeichert wird, wie lange es aufbewahrt wird und wie es gelöscht wird. Senden Sie keine besonderen Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung) in einem Feld.