Eine nicht primäre E-Mail-Adresse eines Benutzers löschen

DELETE /v1/users/{user_id}/emails/{email_id} · Berechtigung users:write

Löscht eine nicht primäre E-Mail-Adresse des Benutzers. Die primäre Adresse kann nicht gelöscht werden: Machen Sie zuerst eine andere bestätigte Adresse zur primären. Solange die Umgebung eine E-Mail-Adresse verlangt, kann die letzte bestätigte Adresse des Benutzers nicht gelöscht werden. Jede Löschung wird im Verwaltungs-Audit-Log als user.email_removed mit dem API-Schlüssel als Akteur protokolliert. Wird dieselbe Zeile erneut gelöscht, liefert der Aufruf 404, weil die Zeile nicht mehr existiert: Die Wirkung ist idempotent, der Statuscode nicht.

Anfrage

Parameter In Pflicht Beschreibung
user_id path ja Benutzer-ID, Präfix usr_.
email_id path ja ID der E-Mail-Zeile (interne UUID, Kleinbuchstaben, mit Bindestrichen), wie von GET /v1/users/{user_id}/emails zurückgegeben.

Die Anfrage enthält keinen Body.

Antwort

204 No Content.

Fehler

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

HTTP code Wann
409 primary_identifier_required Die Adresse ist die primäre Adresse.
409 last_verified_channel Die Umgebung verlangt eine E-Mail-Adresse und dies ist die letzte bestätigte Adresse.
404 not_found Der Benutzer oder die E-Mail-Zeile existiert in dieser Umgebung nicht, die E-Mail-Adresse gehört nicht zu diesem Benutzer oder eine ID ist fehlerhaft.
401 unauthenticated Der API-Schlüssel fehlt, ist ungültig oder wurde widerrufen.
403 insufficient_permissions Dem Schlüssel fehlt die Berechtigung users:write.
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 -X DELETE https://api.eu.keenauth.com/v1/users/usr_0a1b2c3d4e5f6g7h8j9k0m1n2p/emails/0191f0a0-3333-7444-8555-666666666666 \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

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. Übermitteln Sie in keinem Feld besondere Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung).