E-Mail-Adresse als Hauptadresse festlegen
POST /fapi/v1/me/emails/{email_id}:set-primary · wird vom Anmeldehost der Umgebung aufgerufen
Macht eine der bestätigten E-Mail-Adressen des authentifizierten Benutzers zur Hauptadresse. Eine unbestätigte Adresse kann nicht zur Hauptadresse werden; bestätigen Sie sie zuerst. Nach der Änderung erhalten die bisherige Hauptadresse und die übrigen bestätigten Adressen des Benutzers eine Sicherheitsbenachrichtigung mit einem Link „Das war ich nicht“, der die Kontowiederherstellung öffnet. Ist die Adresse bereits die Hauptadresse, lautet die Antwort trotzdem 204, und es ändert sich nichts und es wird nichts gesendet. Erfordert das Cookie __Host-idp_session des authentifizierten Benutzers; fehlt das Cookie, ist es abgelaufen oder widerrufen, wird 401 unauthenticated zurückgegeben. Eine Erstanbieter-Anwendung auf einem anderen Ursprung kann stattdessen ihr Front-API-Zugriffstoken senden (Authorization: DPoP <token> mit einem DPoP-Nachweis; siehe Front-API-Zugriffstoken).
Die Sitzung muss in den letzten 5 Minuten verifiziert worden sein. Hat der Benutzer einen zweiten Faktor, muss die Sitzung außerdem mit einem zweiten Faktor (urn:idp:acr:mfa) geöffnet worden sein.
Anfrage
Header:
| Header | Erforderlich | Beschreibung |
|---|---|---|
Idp-Client |
ja | SDK-Kennung. |
Origin |
ja | Muss exakt https://<sign-in host> sein. |
email_id: der Bezeichner der E-Mail-Adresse, derselbe Wert, den die Endpunkte /v1/users/{user_id}/emails der Verwaltungs-API verwenden (UUID in Kleinbuchstaben).
Kein Body.
Antwort
204 No Content.
Fehler
| Status | Code | Wann |
|---|---|---|
| 401 | unauthenticated |
Kein gültiges Sitzungs-Cookie. |
| 401 | step_up_required |
Die Sitzung wurde nicht in den letzten 5 Minuten verifiziert oder ein zweiter Faktor ist erforderlich; verifizieren Sie erneut mit max_age=300 (und gegebenenfalls acr_values) im Header WWW-Authenticate. |
| 403 | origin_not_allowed |
Origin fehlt oder ist falsch. |
| 404 | not_found |
Für diesen Benutzer gibt es keine solche E-Mail-Adresse. |
| 409 | primary_requires_verified |
Die E-Mail-Adresse ist nicht bestätigt. |
Beispiel
curl -X POST https://example.keenauth.app/fapi/v1/me/emails/0190a5c4-1b2c-7d3e-8f40-516273849abc:set-primary \
-H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
-H "Origin: https://example.keenauth.app" \
-b cookies.txt
Personenbezogene Daten
Dieser Endpunkt verarbeitet personenbezogene Daten: Benutzerprofil. Personenbezogene Daten in den KeenAuth APIs beschreibt, welche Daten gespeichert werden, wie lange sie aufbewahrt werden und wie sie gelöscht werden. Senden Sie in keinem Feld besondere Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung).