Einen Benutzer abrufen

GET /v1/users/{user_id} · Berechtigung users:read

Gibt einen Benutzer zurück. Ein Benutzer aus einer anderen Umgebung, ein nicht existierender Benutzer und ein gelöschter Benutzer liefern alle 404. Die Existenz eines Benutzers wird über Umgebungen hinweg nie offengelegt.

Anfrage

Parameter In Pflicht Beschreibung
user_id Pfad ja Benutzer-ID mit dem Präfix usr_.
include Query nein Auf deleted setzen, um für einen gelöschten Benutzer einen Grabstein statt 404 zu erhalten.

Mit include=deleted liefert ein gelöschter Benutzer 410 mit deleted_at, deletion_id, backups_purged_by (das Datum, bis zu dem die Daten aus den Backups entfernt werden) und bei einem zusammengeführten Benutzer merged_into. Ein Benutzer, der nie existiert hat, liefert weiterhin 404.

Antwort

200 OK. Der Body ist das Benutzerobjekt. Der Header ETag enthält die Version des Benutzers.

Personenbezogene Daten werden maskiert, wenn dem Schlüssel die Berechtigung users:read_pii fehlt: email wird zu a***@e***.com, phone_number behält nur die letzten 2 Ziffern (+**********67), name, given_name, family_name, middle_name und nickname werden zu Initialen (A. L.), username behält nur das erste Zeichen (a***), birthdate wird zu ****-**-** und address wird zu {"redacted": true}. user_metadata und app_metadata werden nicht maskiert.

{
  "id": "usr_0a1b2c3d4e5f6g7h8j9k0m1n2p",
  "kind": "regular",
  "status": "active",
  "external_id": null,
  "username": null,
  "name": "Ada Lovelace",
  "email": "ada@example.com",
  "email_verified": true,
  "phone_number": null,
  "phone_verified": false,
  "user_metadata": {},
  "app_metadata": {},
  "created_via": "admin_api",
  "created_at": "2026-01-15T09:30:00Z",
  "updated_at": "2026-01-15T09:30:00Z",
  "last_sign_in_at": null,
  "deletion_requested_at": null,
  "deletion_due_at": null
}

Fehler

Jeder Fehler ist ein application/problem+json-Body mit einem stabilen code.

HTTP code Wann
404 not_found Der Benutzer existiert in dieser Umgebung nicht (oder die ID ist fehlerhaft).
410 user_deleted Der Benutzer wurde gelöscht, und include=deleted wurde angefordert. Der Body enthält deleted_at, deletion_id, backups_purged_by und bei einem zusammengeführten Benutzer merged_into.
401 unauthenticated Der API-Schlüssel fehlt, ist ungültig oder wurde widerrufen.
403 insufficient_permissions Dem Schlüssel fehlt die Berechtigung users:read.
429 rate_limited Das Ratenlimit wurde überschritten; beachten Sie Retry-After.
503 service_unavailable Eine Abhängigkeit ist vorübergehend nicht verfügbar; versuchen Sie es später erneut.

Beispiel

curl https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

Personenbezogene Daten

Dieser Endpunkt verarbeitet personenbezogene Daten: Profil des Endbenutzers. Personenbezogene Daten in den KeenAuth-APIs beschreibt, welche Daten gespeichert werden, wie lange sie aufbewahrt und wie sie gelöscht werden. Senden Sie in keinem Feld besondere Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung).