Diese Seite wurde von der Cloud Translation API übersetzt.

Firebase Auth-REST-API

API-Nutzung

Sie können das Firebase Auth-Backend über eine REST-API abfragen. Dies kann für verschiedene Vorgänge wie das Erstellen neuer Benutzer, das Anmelden bestehender Benutzer und das Bearbeiten oder Löschen dieser Benutzer verwendet werden.

In diesem Dokument bezieht sich API_KEY auf den Web-API-Schlüssel, den Sie auf der Seite mit den Projekteinstellungen in Ihrer Admin-Konsole erhalten können.

Tauschen Sie das benutzerdefinierte Token gegen eine ID und ein Aktualisierungstoken aus

Sie können ein benutzerdefiniertes Auth-Token gegen eine ID und ein Aktualisierungstoken austauschen, indem Sie eine HTTP- POST Anfrage an den Auth- verifyCustomToken Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
Zeichen	Zeichenfolge	Ein benutzerdefiniertes Firebase Auth-Token, aus dem ein Paar aus ID und Aktualisierungstoken erstellt werden soll.
returnSecureToken	Boolescher Wert	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token, das aus dem bereitgestellten benutzerdefinierten Token generiert wird.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken, das aus dem bereitgestellten benutzerdefinierten Token generiert wird.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"token":"[CUSTOM_TOKEN]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts und [CUSTOM_TOKEN] durch das generierte benutzerdefinierte Auth-Token ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält das Firebase-ID-Token und das Aktualisierungstoken, die dem benutzerdefinierten Token zugeordnet sind.

Beispielantwort

{
  "idToken": "[ID_TOKEN]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

INVALID_CUSTOM_TOKEN: Das benutzerdefinierte Token-Format ist falsch oder das Token ist aus irgendeinem Grund ungültig (z. B. abgelaufen, ungültige Signatur usw.)
CREDENTIAL_MISMATCH: Das benutzerdefinierte Token entspricht einem anderen Firebase-Projekt.

Tauschen Sie einen Aktualisierungstoken gegen einen ID-Token aus

Sie können ein Firebase-ID-Token aktualisieren, indem Sie eine HTTP- POST Anfrage an den Endpunkt securetoken.googleapis.com senden.

Hinweis: Standardmäßig validiert Google die Projektnummer Ihres Aktualisierungstokens, um sicherzustellen, dass sie mit der Ihres API-Schlüssels übereinstimmt. Wenn die Projektnummer nicht übereinstimmt, erhalten Sie den Fehlercode PROJECT_NUMBER_MISMATCH . Diese Validierung verringert das potenzielle Risiko, dass Missbraucher Ihre API-Schlüssel sammeln, um Aktualisierungstoken für ihre eigenen Projekte zu generieren. Wenn Sie das Risiko verstehen und sich von diesem Verhalten abmelden möchten, können Sie einen Ausnahmeantrag einreichen, indem Sie eine Google Cloud- Supportanfrage einreichen.

Methode: POST

Inhaltstyp: application/x-www-form-urlencoded

Endpunkt

https://securetoken.googleapis.com/v1/token?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
grant_type	Zeichenfolge	Der Gewährungstyp des Aktualisierungstokens, immer „refresh_token“.
Refresh_token	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.
token_type	Zeichenfolge	Der Typ des Aktualisierungstokens, immer „Bearer“.
Refresh_token	Zeichenfolge	Das in der Anfrage bereitgestellte Firebase Auth-Aktualisierungstoken oder ein neues Aktualisierungstoken.
id_token	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token.
Benutzer-ID	Zeichenfolge	Die UID, die dem bereitgestellten ID-Token entspricht.
Projekt_ID	Zeichenfolge	Ihre Firebase-Projekt-ID.

Musteranfrage

curl 'https://securetoken.googleapis.com/v1/token?key=[API_KEY]' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data 'grant_type=refresh_token&refresh_token=[REFRESH_TOKEN]'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts und [REFRESH_TOKEN] durch das Firebase-Aktualisierungstoken ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält das neue Firebase-ID-Token und das Aktualisierungstoken.

Beispielantwort

{
  "expires_in": "3600",
  "token_type": "Bearer",
  "refresh_token": "[REFRESH_TOKEN]",
  "id_token": "[ID_TOKEN]",
  "user_id": "tRcfmLH7o2XrNELi...",
  "project_id": "1234567890"
}

Häufige Fehlercodes

TOKEN_EXPIRED: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
USER_DISABLED: Das Benutzerkonto wurde von einem Administrator deaktiviert.
USER_NOT_FOUND: Der dem Aktualisierungstoken entsprechende Benutzer wurde nicht gefunden. Es ist wahrscheinlich, dass der Benutzer gelöscht wurde.
API-Schlüssel ungültig. Bitte übergeben Sie einen gültigen API-Schlüssel. (Ungültiger API-Schlüssel angegeben)
INVALID_REFRESH_TOKEN: Es wurde ein ungültiges Aktualisierungstoken bereitgestellt.
Ungültige JSON-Nutzlast empfangen. Unbekannter Name „refresh_tokens“: Abfrageparameter kann nicht gebunden werden. Das Feld „refresh_tokens“ konnte in der Anforderungsnachricht nicht gefunden werden.
INVALID_GRANT_TYPE: Der angegebene Grant-Typ ist ungültig.
MISSING_REFRESH_TOKEN: Kein Aktualisierungstoken bereitgestellt.
PROJECT_NUMBER_MISMATCH: Die Projektnummer des Aktualisierungstokens stimmt nicht mit der des bereitgestellten API-Schlüssels überein.

Melden Sie sich mit E-Mail/Passwort an

Sie können einen neuen E-Mail- und Passwortbenutzer erstellen, indem Sie eine HTTP- POST Anfrage an den Auth signupNewUser Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	Die E-Mail, die der Benutzer erstellen soll.
Passwort	Zeichenfolge	Das Passwort, das der Benutzer erstellen soll.
returnSecureToken	Boolescher Wert	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token für den neu erstellten Benutzer.
Email	Zeichenfolge	Die E-Mail für den neu erstellten Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken für den neu erstellten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.
Local ID	Zeichenfolge	Die UID des neu erstellten Benutzers.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [user@example.com] durch die E-Mail-Adresse des neuen Benutzers und [PASSWORD] durch das Passwort des neuen Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält das Firebase-ID-Token und das Aktualisierungstoken, die dem neuen Konto zugeordnet sind.

Beispielantwort

{
  "idToken": "[ID_TOKEN]",
  "email": "[user@example.com]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "localId": "tRcfmLH7..."
}

Häufige Fehlercodes

EMAIL_EXISTS: Die E-Mail-Adresse wird bereits von einem anderen Konto verwendet.
OPERATION_NOT_ALLOWED: Die Passwortanmeldung ist für dieses Projekt deaktiviert.
TOO_MANY_ATTEMPTS_TRY_LATER: Wir haben alle Anfragen von diesem Gerät aufgrund ungewöhnlicher Aktivität blockiert. Versuchen Sie es später erneut.

Sie können einen Benutzer mit einer E-Mail-Adresse und einem Passwort anmelden, indem Sie eine HTTP- POST Anfrage an den Auth- verifyPassword Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	Die E-Mail-Adresse, mit der sich der Benutzer anmeldet.
Passwort	Zeichenfolge	Das Passwort für das Konto.
returnSecureToken	Boolescher Wert	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token für den authentifizierten Benutzer.
Email	Zeichenfolge	Die E-Mail für den authentifizierten Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken für den authentifizierten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.
Local ID	Zeichenfolge	Die UID des authentifizierten Benutzers.
Eingetragen	Boolescher Wert	Ob die E-Mail für ein bestehendes Konto gilt.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [user@example.com] durch die E-Mail-Adresse des Benutzers und [PASSWORD] durch das Passwort des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält das Firebase-ID-Token und das Aktualisierungstoken, die mit dem vorhandenen E-Mail-/Passwort-Konto verknüpft sind.

Beispielantwort

{
  "localId": "ZY1rJK0eYLg...",
  "email": "[user@example.com]",
  "displayName": "",
  "idToken": "[ID_TOKEN]",
  "registered": true,
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

EMAIL_NOT_FOUND: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.
INVALID_PASSWORD: Das Passwort ist ungültig oder der Benutzer hat kein Passwort.
USER_DISABLED: Das Benutzerkonto wurde von einem Administrator deaktiviert.

Sie können einen Benutzer anonym anmelden, indem Sie eine HTTP- POST Anfrage an den Endpunkt Auth signupNewUser senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
returnSecureToken	Boolescher Wert	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token für den neu erstellten Benutzer.
Email	Zeichenfolge	Da der Benutzer anonym ist, sollte dieses Feld leer sein.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken für den neu erstellten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.
Local ID	Zeichenfolge	Die UID des neu erstellten Benutzers.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält das Firebase-ID-Token und das Aktualisierungstoken, die dem anonymen Benutzer zugeordnet sind.

Beispielantwort

{
  "idToken": "[ID_TOKEN]",
  "email": "",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "localId": "Jws4SVjpT..."
}

Häufige Fehlercodes

OPERATION_NOT_ALLOWED: Die anonyme Benutzeranmeldung ist für dieses Projekt deaktiviert.

Sie können einen Benutzer mit OAuth-Anmeldeinformationen anmelden, indem Sie eine HTTP- POST Anfrage an den Auth- verifyAssertion Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
requestUri	Zeichenfolge	Der URI, zu dem der IDP den Benutzer zurückleitet.
postBody	Zeichenfolge	Enthält die OAuth-Anmeldeinformationen (ein ID-Token oder Zugriffstoken) und die Anbieter-ID, die die Anmeldeinformationen ausstellt.
returnSecureToken	Boolescher Wert	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht. Sollte immer wahr sein.
returnIdpCredential	Boolescher Wert	Ob die Rückgabe der OAuth-Anmeldeinformationen bei den folgenden Fehlern erzwungen werden soll: FEDERATED_USER_ID_ALREADY_LINKED und EMAIL_EXISTS.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
federatedId	Zeichenfolge	Die eindeutige ID identifiziert das IdP-Konto.
Anbieter-ID	Zeichenfolge	Die verknüpfte Anbieter-ID (z. B. „google.com“ für den Google-Anbieter).
Local ID	Zeichenfolge	Die UID des authentifizierten Benutzers.
Email überprüft	Boolescher Wert	Ob die Anmelde-E-Mail verifiziert ist.
Email	Zeichenfolge	Die E-Mail-Adresse des Kontos.
oauthIdToken	Zeichenfolge	Das OIDC-ID-Token, falls verfügbar.
oauthAccessToken	Zeichenfolge	Das OAuth-Zugriffstoken, falls verfügbar.
oauthTokenSecret	Zeichenfolge	Das OAuth 1.0-Token-Geheimnis, falls verfügbar.
rawUserInfo	Zeichenfolge	Die stringifizierte JSON-Antwort, die alle IdP-Daten enthält, die den bereitgestellten OAuth-Anmeldeinformationen entsprechen.
Vorname	Zeichenfolge	Der Vorname für das Konto.
Familienname, Nachname	Zeichenfolge	Der Nachname des Kontos.
vollständiger Name	Zeichenfolge	Der vollständige Name für das Konto.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
FotoUrl	Zeichenfolge	Die Foto-URL für das Konto.
idToken	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token für den authentifizierten Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken für den authentifizierten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.
braucheBestätigung	Boolescher Wert	Ob bereits ein anderes Konto mit denselben Anmeldeinformationen vorhanden ist. Der Benutzer muss sich beim ursprünglichen Konto anmelden und dann die aktuellen Anmeldeinformationen damit verknüpfen.

Beispielanforderung mit OAuth-ID-Token

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [GOOGLE_ID_TOKEN] durch das Google OAuth-ID-Token, [google.com] durch die Anbieter-ID ersetzen, die den OAuth-Anmeldeinformationen entspricht, und [http://localhost] mit dem Anforderungs-URI.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält das Firebase-ID-Token und das Aktualisierungstoken, die dem authentifizierten Benutzer zugeordnet sind.

Beispielantwort mit OAuth-ID-Token

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthIdToken": "[GOOGLE_ID_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Beispielanforderung mit OAuth-Zugriffstoken

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [FACEBOOK_ACCESS_TOKEN] durch das Facebook-Zugriffstoken, [facebook.com] durch die Anbieter-ID ersetzen, die den OAuth-Anmeldeinformationen entspricht, und [http://localhost] mit der Anforderungs-URI.

Beispielantwort mit OAuth-Zugriffstoken

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://scontent.xx.fbcdn.net/v/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Beispielanforderung mit Twitter OAuth 1.0-Anmeldeinformationen

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [TWITTER_ACCESS_TOKEN] durch das Twitter OAuth-Zugriffstoken, [TWITTER_TOKEN_SECRET] durch das Twitter OAuth-Token-Geheimnis und [twitter.com] durch die Anbieter-ID ersetzen entsprechend den OAuth-Anmeldeinformationen und [http://localhost] mit dem Anforderungs-URI.

Beispielantwort mit Twitter OAuth 1.0-Anmeldeinformationen

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]",
  "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "http://abs.twimg.com/sticky/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Häufige Fehlercodes

OPERATION_NOT_ALLOWED: Der entsprechende Anbieter ist für dieses Projekt deaktiviert.
INVALID_IDP_RESPONSE: Die angegebenen Authentifizierungsdaten sind fehlerhaft oder abgelaufen.

Anbieter für E-Mail abrufen

Sie können alle mit einer bestimmten E-Mail verknüpften Anbieter anzeigen, indem Sie eine HTTP- POST Anfrage an den Auth- createAuthUri Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
Identifikator	Zeichenfolge	E-Mail-Adresse des Benutzers
continueUri	Zeichenfolge	Der URI, zu dem der IDP den Benutzer zurückleitet. Für diesen Anwendungsfall ist dies nur die aktuelle URL.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
alleAnbieter	Liste der Zeichenfolgen	Die Liste der Anbieter, bei denen sich der Benutzer zuvor angemeldet hat.
Eingetragen	Boolescher Wert	Ob die E-Mail für ein bestehendes Konto gilt

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"identifier":"[user@example.com]","continueUri":"[http://localhost:8080/app]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [user@example.com] durch die zu suchende E-Mail und [http://localhost:8080/app] durch die aktuelle URL ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält die Liste der mit der E-Mail verknüpften Anbieter.

Beispielantwort

{
  "allProviders": [
    "password",
    "google.com"
  ],
  "registered": true
}

Häufige Fehlercodes

INVALID_EMAIL: Die E-Mail-Adresse ist falsch formatiert.

Senden Sie eine E-Mail zum Zurücksetzen des Passworts

Sie können eine E-Mail zum Zurücksetzen des Passworts senden, indem Sie eine HTTP- POST Anfrage an den Endpunkt Auth getOobConfirmationCode senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]

Optionale Header

Name des Anwesens	Beschreibung
X-Firebase-Gebietsschema	Der Sprachcode, der dem Gebietsschema des Benutzers entspricht. Wenn Sie dies übergeben, wird die an den Benutzer gesendete E-Mail zum Zurücksetzen des Passworts lokalisiert.

Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
Anfragetyp	Zeichenfolge	Die Art des zurückzugebenden OOB-Codes. Sollte zum Zurücksetzen des Passworts „PASSWORD_RESET“ sein.
Email	Zeichenfolge	E-Mail-Adresse des Benutzers.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	E-Mail-Adresse des Benutzers.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"requestType":"PASSWORD_RESET","email":"[user@example.com]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts ersetzen, [user@example.com] durch die E-Mail-Adresse, an die das Zurücksetzen des Passworts gesendet werden soll.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt.

Beispielantwort

{
 "email": "[user@example.com]"
}

Häufige Fehlercodes

EMAIL_NOT_FOUND: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Überprüfen Sie den Code zum Zurücksetzen des Passworts

Sie können einen Passwort-Reset-Code überprüfen, indem Sie eine HTTP- POST Anfrage an den Auth- resetPassword Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
oobCode	Zeichenfolge	Der E-Mail-Aktionscode, der zum Zurücksetzen des Passworts an die E-Mail-Adresse des Benutzers gesendet wird.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	E-Mail-Adresse des Benutzers.
Anfragetyp	Zeichenfolge	Typ des E-Mail-Aktionscodes. Sollte „PASSWORD_RESET“ sein.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"oobCode":"[PASSWORD_RESET_CODE]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts und [PASSWORD_RESET_CODE] durch den Aktionscode zum Zurücksetzen des Passworts ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt.

Beispielantwort

{
  "email": "[user@example.com]",
  "requestType": "PASSWORD_RESET"
}

Häufige Fehlercodes

OPERATION_NOT_ALLOWED: Die Passwortanmeldung ist für dieses Projekt deaktiviert.
EXPIRED_OOB_CODE: Der Aktionscode ist abgelaufen.
INVALID_OOB_CODE: Der Aktionscode ist ungültig. Dies kann passieren, wenn der Code fehlerhaft ist, abgelaufen ist oder bereits verwendet wurde.

Bestätigen Sie das Zurücksetzen des Passworts

Sie können eine Änderung zum Zurücksetzen des Passworts anwenden, indem Sie eine HTTP- POST Anfrage an den Auth- resetPassword Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
oobCode	Zeichenfolge	Der E-Mail-Aktionscode, der zum Zurücksetzen des Passworts an die E-Mail-Adresse des Benutzers gesendet wird.
Neues Kennwort	Zeichenfolge	Das neue Passwort des Benutzers.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	E-Mail-Adresse des Benutzers.
Anfragetyp	Zeichenfolge	Typ des E-Mail-Aktionscodes. Sollte „PASSWORD_RESET“ sein.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"oobCode":"[PASSWORD_RESET_CODE]","newPassword":"[NEW_PASSWORD]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [PASSWORD_RESET_CODE] durch den Aktionscode zum Zurücksetzen des Passworts und [NEW_PASSWORD] durch das neue Passwort des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt.

Beispielantwort

{
  "email": "[user@example.com]",
  "requestType": "PASSWORD_RESET"
}

Häufige Fehlercodes

OPERATION_NOT_ALLOWED: Die Passwortanmeldung ist für dieses Projekt deaktiviert.
EXPIRED_OOB_CODE: Der Aktionscode ist abgelaufen.
INVALID_OOB_CODE: Der Aktionscode ist ungültig. Dies kann passieren, wenn der Code fehlerhaft ist, abgelaufen ist oder bereits verwendet wurde.
USER_DISABLED: Das Benutzerkonto wurde von einem Administrator deaktiviert.

Ändern Sie die E-Mail

Sie können die E-Mail-Adresse eines Benutzers ändern, indem Sie eine HTTP- POST Anfrage an den Endpunkt Auth setAccountInfo senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Optionale Header

Name des Anwesens	Beschreibung
X-Firebase-Gebietsschema	Der Sprachcode, der dem Gebietsschema des Benutzers entspricht. Wenn Sie dies übergeben, wird der an den Benutzer gesendete E-Mail-Änderungswiderruf lokalisiert.

Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token für den Benutzer.
Email	Zeichenfolge	Die neue E-Mail-Adresse des Benutzers.
returnSecureToken	Boolescher Wert	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	E-Mail-Adresse des Benutzers.
PasswortHash	Zeichenfolge	Hash-Version des Passworts.
anbieterUserInfo	Liste der JSON-Objekte	Liste aller verknüpften Provider-Objekte, die „providerId“ und „federatedId“ enthalten.
idToken	Zeichenfolge	Neues Firebase-Authentifizierungs-ID-Token für Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[FIREBASE_ID_TOKEN]","email":"[user@example2.com]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [FIREBASE_ID_TOKEN] durch das Firebase-ID-Token des Benutzers und [user@example2.com] durch die neue E-Mail-Adresse des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält das neue Firebase-ID-Token und das Aktualisierungstoken, die dem Benutzer zugeordnet sind.

Beispielantwort

{
  "localId": "tRcfmLH7o2...",
  "email": "[user@example2.com]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[user@example2.com]"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

EMAIL_EXISTS: Die E-Mail-Adresse wird bereits von einem anderen Konto verwendet.
INVALID_ID_TOKEN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.

Kennwort ändern

Sie können das Kennwort eines Benutzers ändern, indem Sie eine HTTP- POST Anfrage an den Endpunkt Auth setAccountInfo senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token für den Benutzer.
Passwort	Zeichenfolge	Neues Passwort des Benutzers.
returnSecureToken	Boolescher Wert	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	E-Mail-Adresse des Benutzers.
PasswortHash	Zeichenfolge	Hash-Version des Passworts.
anbieterUserInfo	Liste der JSON-Objekte	Liste aller verknüpften Provider-Objekte, die „providerId“ und „federatedId“ enthalten.
idToken	Zeichenfolge	Neues Firebase-Authentifizierungs-ID-Token für Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[FIREBASE_ID_TOKEN]","password":"[NEW_PASSWORD]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [FIREBASE_ID_TOKEN] durch das Firebase-ID-Token des Benutzers und [NEW_PASSWORD] durch das neue Passwort des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält das neue Firebase-ID-Token und das Aktualisierungstoken, die dem Benutzer zugeordnet sind.

Beispielantwort

{
  "localId": "tRcfmLH7o2...",
  "email": "[user@example.com]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[user@example.com]"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

INVALID_ID_TOKEN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
WEAK_PASSWORD: Das Passwort muss mindestens 6 Zeichen lang sein.

Profil aktualisieren

Sie können das Profil eines Benutzers (Anzeigename/Foto-URL) aktualisieren, indem Sie eine HTTP- POST Anfrage an den Endpunkt Auth setAccountInfo senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token für den Benutzer.
Anzeigename	Zeichenfolge	Der neue Anzeigename des Benutzers.
FotoUrl	Zeichenfolge	Die neue Foto-URL des Benutzers.
deleteAttribute	Liste der Zeichenfolgen	Liste der zu löschenden Attribute „DISPLAY_NAME“ oder „PHOTO_URL“. Dadurch werden diese Werte ungültig.
returnSecureToken	Boolescher Wert	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	E-Mail-Adresse des Benutzers.
Anzeigename	Zeichenfolge	Der neue Anzeigename des Benutzers.
FotoUrl	Zeichenfolge	Die neue Foto-URL des Benutzers.
PasswortHash	Zeichenfolge	Hash-Version des Passworts.
anbieterUserInfo	Liste der JSON-Objekte	Liste aller verknüpften Provider-Objekte, die „providerId“ und „federatedId“ enthalten.
idToken	Zeichenfolge	Neues Firebase-Authentifizierungs-ID-Token für Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[ID_TOKEN]","displayName":"[NAME]","photoUrl":"[URL]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [ID_TOKEN] durch das Firebase-ID-Token des Benutzers, [NAME] durch den neuen Anzeigenamen des Benutzers und [URL] durch die neue Foto-URL des Benutzers ersetzen .

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt.

Beispielantwort

{
  "localId": "tRcfmLH...",
  "email": "user@example2.com",
  "displayName": "John Doe",
  "photoUrl": "[http://localhost:8080/img1234567890/photo.png]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example2.com",
      "displayName": "John Doe",
      "photoUrl": "http://localhost:8080/img1234567890/photo.png"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

INVALID_ID_TOKEN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.

Benutzerdaten abrufen

Sie können die Daten eines Benutzers abrufen, indem Sie eine HTTP- POST Anfrage an den Auth- getAccountInfo Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Das Firebase-ID-Token des Kontos.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Benutzer	Liste der JSON-Objekte	Das Konto, das dem angegebenen Firebase-ID-Token zugeordnet ist. Weitere Einzelheiten finden Sie weiter unten.

Antwortnutzlast (Array-Inhalt users )

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	Die E-Mail-Adresse des Kontos.
Email überprüft	Boolescher Wert	Ob die E-Mail-Adresse des Kontos bestätigt wurde oder nicht.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
anbieterUserInfo	Liste der JSON-Objekte	Liste aller verknüpften Provider-Objekte, die „providerId“ und „federatedId“ enthalten.
FotoUrl	Zeichenfolge	Die Foto-URL für das Konto.
PasswortHash	Zeichenfolge	Hash-Version des Passworts.
PasswortUpdatedAt	doppelt	Der Zeitstempel (in Millisekunden), dass das Kontokennwort zuletzt geändert wurde.
validSince	Zeichenfolge	Der Zeitstempel in Sekunden, der eine Grenze markiert, vor der Firebase-ID-Token als widerrufen gelten.
deaktiviert	Boolescher Wert	Ob das Konto deaktiviert ist oder nicht.
lastLoginAt	Zeichenfolge	Der Zeitstempel (in Millisekunden), zu dem sich das Konto zuletzt angemeldet hat.
hergestellt in	Zeichenfolge	Der Zeitstempel in Millisekunden, zu dem das Konto erstellt wurde.
customAuth	Boolescher Wert	Ob das Konto vom Entwickler authentifiziert ist.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts und [FIREBASE_ID_TOKEN] durch das Firebase-ID-Token des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt. Die Antwort enthält alle mit dem Konto verknüpften Benutzerinformationen.

Beispielantwort

{
  "users": [
    {
      "localId": "ZY1rJK0...",
      "email": "user@example.com",
      "emailVerified": false,
      "displayName": "John Doe",
      "providerUserInfo": [
        {
          "providerId": "password",
          "displayName": "John Doe",
          "photoUrl": "http://localhost:8080/img1234567890/photo.png",
          "federatedId": "user@example.com",
          "email": "user@example.com",
          "rawId": "user@example.com",
          "screenName": "user@example.com"
        }
      ],
      "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
      "passwordHash": "...",
      "passwordUpdatedAt": 1.484124177E12,
      "validSince": "1484124177",
      "disabled": false,
      "lastLoginAt": "1484628946000",
      "createdAt": "1484124142000",
      "customAuth": false
    }
  ]
}

Häufige Fehlercodes

INVALID_ID_TOKEN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
USER_NOT_FOUND: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Link mit E-Mail/Passwort

Sie können eine E-Mail/ein Passwort mit einem aktuellen Benutzer verknüpfen, indem Sie eine HTTP- POST Anfrage an den Endpunkt Auth setAccountInfo senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Das Firebase-ID-Token des Kontos, mit dem Sie die Anmeldeinformationen verknüpfen möchten.
Email	Zeichenfolge	Die E-Mail zur Verknüpfung mit dem Konto.
Passwort	Zeichenfolge	Das neue Passwort des Kontos.
returnSecureToken	Zeichenfolge	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	Die E-Mail-Adresse des Kontos.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
FotoUrl	Zeichenfolge	Die Foto-URL für das Konto.
PasswortHash	Zeichenfolge	Hash-Version des Passworts.
anbieterUserInfo	Liste der JSON-Objekte	Liste aller verknüpften Provider-Objekte, die „providerId“ und „federatedId“ enthalten.
Email überprüft	Boolescher Wert	Ob die E-Mail-Adresse des Kontos bestätigt wurde oder nicht.
idToken	Zeichenfolge	Neues Firebase-Authentifizierungs-ID-Token für Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[ID_TOKEN]","email":"[user@example.com]","password":"[PASS]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [ID_TOKEN] durch das Firebase-ID-Token des Benutzers, [user@example.com] durch die E-Mail-Adresse des Benutzers, die verknüpft werden muss, und [PASS] mit dem Passwort, das verknüpft werden muss.

Beispielantwort

{
  "localId": "huDwUz...",
  "email": "user@example.com",
  "displayName": "John Doe",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ],
  "idToken": "[ID_TOKEN]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "emailVerified": false
}

Häufige Fehlercodes

CREDENTIAL_TOO_OLD_LOGIN_AGAIN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
TOKEN_EXPIRED: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
INVALID_ID_TOKEN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
WEAK_PASSWORD: Das Passwort muss mindestens 6 Zeichen lang sein.

Verknüpfung mit OAuth-Anmeldeinformationen

Sie können OAuth-Anmeldeinformationen mit einem Benutzer verknüpfen, indem Sie eine HTTP- POST Anfrage an den Auth- verifyAssertion Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Das Firebase-ID-Token des Kontos, mit dem Sie die Anmeldeinformationen verknüpfen möchten.
requestUri	Zeichenfolge	Der URI, zu dem der IDP den Benutzer zurückleitet.
postBody	Zeichenfolge	Enthält die OAuth-Anmeldeinformationen (ein ID-Token oder Zugriffstoken) und die Anbieter-ID, die die Anmeldeinformationen ausstellt.
returnSecureToken	Boolescher Wert	Ob eine ID und ein Aktualisierungstoken zurückgegeben werden sollen oder nicht. Sollte immer wahr sein.
returnIdpCredential	Boolescher Wert	Ob die Rückgabe der OAuth-Anmeldeinformationen bei den folgenden Fehlern erzwungen werden soll: FEDERATED_USER_ID_ALREADY_LINKED und EMAIL_EXISTS.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
federatedId	Zeichenfolge	Die eindeutige ID identifiziert das IdP-Konto.
Anbieter-ID	Zeichenfolge	Die verknüpfte Anbieter-ID (z. B. „google.com“ für den Google-Anbieter).
Local ID	Zeichenfolge	Die UID des authentifizierten Benutzers.
Email überprüft	Boolescher Wert	Ob die Anmelde-E-Mail verifiziert ist.
Email	Zeichenfolge	Die E-Mail-Adresse des Kontos.
oauthIdToken	Zeichenfolge	Das OIDC-ID-Token, falls verfügbar.
oauthAccessToken	Zeichenfolge	Das OAuth-Zugriffstoken, falls verfügbar.
oauthTokenSecret	Zeichenfolge	Das OAuth 1.0-Token-Geheimnis, falls verfügbar.
rawUserInfo	Zeichenfolge	Die stringifizierte JSON-Antwort, die alle IdP-Daten enthält, die den bereitgestellten OAuth-Anmeldeinformationen entsprechen.
Vorname	Zeichenfolge	Der Vorname für das Konto.
Familienname, Nachname	Zeichenfolge	Der Nachname des Kontos.
vollständiger Name	Zeichenfolge	Der vollständige Name für das Konto.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
FotoUrl	Zeichenfolge	Die Foto-URL für das Konto.
idToken	Zeichenfolge	Ein Firebase-Authentifizierungs-ID-Token für den authentifizierten Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth-Aktualisierungstoken für den authentifizierten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID-Token abläuft.

Beispielanforderung mit OAuth-ID-Token

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [FIREBASE_ID_TOKEN] durch das Firebase-ID-Token des aktuellen Benutzers, [GOOGLE_ID_TOKEN] durch das Google OAuth-ID-Token und [google.com] durch den Anbieter ersetzen ID, die den OAuth-Anmeldeinformationen entspricht, und [http://localhost] mit dem Anforderungs-URI.

Beispielantwort mit OAuth-ID-Token

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthIdToken": "[GOOGLE_ID_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Beispielanforderung mit OAuth-Zugriffstoken

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","idToken":"[FIREBASE_ID_TOKEN]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [FIREBASE_ID_TOKEN] durch das Firebase-ID-Token des aktuellen Benutzers, [FACEBOOK_ACCESS_TOKEN] durch das Facebook-Zugriffstoken und [facebook.com] durch die Anbieter-ID ersetzen entsprechend den OAuth-Anmeldeinformationen und [http://localhost] mit dem Anforderungs-URI.

Beispielantwort mit OAuth-Zugriffstoken

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://scontent.xx.fbcdn.net/v/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Beispielanforderung mit Twitter OAuth 1.0-Anmeldeinformationen

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [FIREBASE_ID_TOKEN] durch das Firebase-ID-Token des aktuellen Benutzers, [TWITTER_ACCESS_TOKEN] durch das Twitter-OAuth-Zugriffstoken und [TWITTER_TOKEN_SECRET] durch das Twitter-OAuth-Token ersetzen Secret, [twitter.com] mit der Anbieter-ID, die den OAuth-Anmeldeinformationen entspricht, und [http://localhost] mit dem Anforderungs-URI.

Beispielantwort mit Twitter OAuth 1.0-Anmeldeinformationen

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]",
  "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "http://abs.twimg.com/sticky/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Häufige Fehlercodes

OPERATION_NOT_ALLOWED: Der entsprechende Anbieter ist für dieses Projekt deaktiviert.
INVALID_IDP_RESPONSE: Die angegebenen Authentifizierungsdaten sind fehlerhaft oder abgelaufen.
INVALID_ID_TOKEN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
EMAIL_EXISTS: Die E-Mail-Adresse wird bereits von einem anderen Konto verwendet.
FEDERATED_USER_ID_ALREADY_LINKED: Diese Anmeldeinformationen sind bereits einem anderen Benutzerkonto zugeordnet.

Verknüpfung mit dem Anbieter aufheben

Sie können die Verknüpfung eines Anbieters mit einem aktuellen Benutzer aufheben, indem Sie eine HTTP- POST Anfrage an den Endpunkt Auth setAccountInfo senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Das Firebase-ID-Token des Kontos.
deleteProvider	Liste der Zeichenfolgen	Die Liste der Anbieter-IDs, deren Verknüpfung aufgehoben werden soll, z. B. „google.com“, „password“ usw.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	Die E-Mail-Adresse des Kontos.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
FotoUrl	Zeichenfolge	Die Foto-URL für das Konto.
PasswortHash	Zeichenfolge	Hash-Version des Passworts.
anbieterUserInfo	Liste der JSON-Objekte	Liste aller verknüpften Provider-Objekte, die „providerId“ und „federatedId“ enthalten.
Email überprüft	Boolescher Wert	Ob die E-Mail-Adresse des Kontos bestätigt wurde oder nicht.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"idToken":"[FIREBASE_ID_TOKEN]","deleteProvider":["[facebook.com]"]}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts, [FIREBASE_ID_TOKEN] durch das Firebase-ID-Token des Benutzers und [facebook.com] durch die Anbieter-ID zum Aufheben der Verknüpfung ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt.

Beispielantwort

{
  "localId": "huDwUz...",
  "email": "user@example.com",
  "displayName": "John Doe",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "google.com",
      "federatedId": "1234567890",
      "displayName": "John Doe",
      "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg"
    },
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ],
  "emailVerified": "true"
}

Häufige Fehlercodes

INVALID_ID_TOKEN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.

E-Mail-Bestätigung senden

Sie können eine E-Mail-Bestätigung für den aktuellen Benutzer senden, indem Sie eine HTTP- POST Anfrage an den Endpunkt Auth getOobConfirmationCode senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]

Optionale Header

Name des Anwesens	Beschreibung
X-Firebase-Gebietsschema	Der Sprachcode, der dem Gebietsschema des Benutzers entspricht. Wenn Sie dies bestehen, wird die an den Benutzer gesendete E-Mail-Bestätigung lokalisiert.

Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
Anfragetyp	Zeichenfolge	Der Typ des zu sendenden Bestätigungscodes. Sollte immer „VERIFY_EMAIL“ lauten.
idToken	Zeichenfolge	Das Firebase-ID-Token des zu überprüfenden Benutzers.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	Die E-Mail-Adresse des Kontos.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"requestType":"VERIFY_EMAIL","idToken":"[FIREBASE_ID_TOKEN]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts und [FIREBASE_ID_TOKEN] durch das Firebase-ID-Token des aktuellen Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt.

Beispielantwort

{
  "email": "user@example.com"
}

Häufige Fehlercodes

INVALID_ID_TOKEN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
USER_NOT_FOUND: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Bestätigen Sie die E-Mail-Bestätigung

Sie können einen E-Mail-Bestätigungscode bestätigen, indem Sie eine HTTP- POST Anfrage an den Auth setAccountInfo Endpunkt senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
oobCode	Zeichenfolge	Der Aktionscode, der zur E-Mail-Verifizierung an die E-Mail-Adresse des Benutzers gesendet wird.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	Die E-Mail-Adresse des Kontos.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
FotoUrl	Zeichenfolge	Die Foto-URL für das Konto.
PasswortHash	Zeichenfolge	Der Passwort-Hash.
anbieterUserInfo	Liste der JSON-Objekte	Liste aller verknüpften Provider-Objekte, die „providerId“ und „federatedId“ enthalten.
Email überprüft	Boolescher Wert	Ob die E-Mail-Adresse des Kontos bestätigt wurde oder nicht.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"oobCode":"[VERIFICATION_CODE]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts und [VERIFICATION_CODE] durch den E-Mail-Bestätigungscode ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt.

Beispielantwort

{
  "localId": "FhyStE...",
  "email": "user@example.com",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ]
}

Häufige Fehlercodes

EXPIRED_OOB_CODE: Der Aktionscode ist abgelaufen.
INVALID_OOB_CODE: Der Aktionscode ist ungültig. Dies kann passieren, wenn der Code fehlerhaft ist, abgelaufen ist oder bereits verwendet wurde.
USER_DISABLED: Das Benutzerkonto wurde von einem Administrator deaktiviert.
EMAIL_NOT_FOUND: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Konto löschen

Sie können einen aktuellen Benutzer löschen, indem Sie eine HTTP- POST Anfrage an den Endpunkt Auth deleteAccount senden.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
idToken	Zeichenfolge	Das Firebase-ID-Token des zu löschenden Benutzers.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web-API-Schlüssel Ihres Firebase-Projekts und [FIREBASE_ID_TOKEN] durch das Firebase-ID-Token des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch den HTTP-Statuscode 200 OK angezeigt.

Häufige Fehlercodes

INVALID_ID_TOKEN: Die Anmeldeinformationen des Benutzers sind nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
USER_NOT_FOUND: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Firebase-Authentifizierungsemulator

Die Firebase Local Emulator Suite enthält einen Authentifizierungsemulator , der für lokales Prototyping und Testen von Authentifizierungsabläufen verwendet werden kann. Der Emulator stellt die folgenden REST-Endpunkte bereit.

HTTP ist erforderlich. Verbindungen zum Emulator erfolgen über localhost und der Emulator unterstützt keine Verschlüsselung.

Benutzerkonten löschen

Entfernen Sie alle Konten im angegebenen Projekt, unabhängig vom Status.

Methode: DELETE

Endpunkt

Beachten Sie, dass 9099 der Standardport für den Authentifizierungsemulator ist. Überprüfen Sie die Terminalausgabe auf den tatsächlich verwendeten Port.

http://localhost:9099/emulator/v1/projects/{project-id}/accounts

Rufen Sie die Emulatorkonfiguration ab

Rufen Sie die emulatorspezifische Konfiguration für das angegebene Projekt ab.

Methode: GET

Endpunkt

Beachten Sie, dass 9099 der Standardport für den Authentifizierungsemulator ist. Überprüfen Sie die Terminalausgabe auf den tatsächlich verwendeten Port.

http://localhost:9099/emulator/v1/projects/{project-id}/config

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
anmelden	Objekt	signIn-Konfigurationsobjekt, das einen einzelnen Schlüssel enthält, `allowDuplicateEmails` (boolean).

Patch-Emulator-Konfiguration

Aktualisieren Sie die emulatorspezifische Konfiguration für das angegebene Projekt.

Methode: PATCH

Endpunkt

Beachten Sie, dass 9099 der Standardport für den Authentifizierungsemulator ist. Überprüfen Sie die Terminalausgabe auf den tatsächlich verwendeten Port.

Inhaltstyp: application/json

http://localhost:9099/emulator/v1/projects/{project-id}/config

Anforderungstext-Nutzlast

Name des Anwesens	Typ	Beschreibung
anmelden	Objekt	Gewünschtes Anmeldekonfigurationsobjekt mit einem einzigen Schlüssel, `allowDuplicateEmails` (boolean).

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
anmelden	Objekt	Konfigurationsobjekt für die Anmeldung nach der Anforderung mit einem einzelnen Schlüssel, `allowDuplicateEmails` (boolean).

Rufen Sie Out-of-Band-Authentifizierungscodes ab

Wenn die Authentifizierungsabläufe, die Sie testen, normalerweise Out-of-Band-Codes generieren würden (z. B. E-Mail-Bestätigungscodes, Codes zum Zurücksetzen von Passwörtern), speichert der Emulator diese Codes intern, bis sie verwendet werden.

Methode: GET

Endpunkt

Beachten Sie, dass 9099 der Standardport für den Authentifizierungsemulator ist. Überprüfen Sie die Terminalausgabe auf den tatsächlich verwendeten Port.

http://localhost:9099/emulator/v1/projects/{project-id}/oobCodes

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
oobCodes	Array	Ein Array von Objekten mit Details zu allen ausstehenden Bestätigungscodes. Jedes Objekt enthält `email` (Zeichenfolge), `oobCode` (Zeichenfolge), `oobLink` (Zeichenfolge) und `requestType` (Zeichenfolge).

Rufen Sie SMS-Bestätigungscodes ab

Wenn Sie Telefon-/SMS -Authentifizierungsströme testen, speichert der Emulator solche SMS -Codes intern, bis sie verwendet werden.

Methode: GET

Endpunkt

Beachten Sie, dass 9099 der Standardport für den Authentifizierungsemulator ist. Überprüfen Sie die Anschlussausgabe für den verwendeten Port.

http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodes

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Verifizierungskoden	Array	Eine Reihe von Objekten, die Details aller ausstehenden Verifizierungscodes enthalten. Jedes Objekt enthält `phoneNumber` (String) und `sessionCode` (String).

Fehlerantwort

Fehlerantwortformat

Immer wenn ein Fehler für eine der oben genannten APIs vom Backend -Server zurückgegeben wird, hat die Antwort das folgende Format.

Probenantwort

{
  "error": {
    "errors": [
      {
        "domain": "global",
        "reason": "invalid",
        "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN"
      }
    ],
    "code": 400,
    "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN"
  }
}

Der Fehlercode wird aus dem Nachrichtenfeld erhalten. Alle oben genannten Fehlercodes beziehen sich auf den Inhalt des Nachrichtenfeldes.

API-Nutzung

Sie können das Firebase Auth Backend durch eine REST -API abfragen. Dies kann für verschiedene Vorgänge verwendet werden, z. B. für das Erstellen neuer Benutzer, die Unterzeichnung vorhanden und das Bearbeiten oder Löschen dieser Benutzer.

In diesem Dokument bezieht sich API_KEY auf den Web -API -Schlüssel, der auf der Seite der Projekteinstellungen in Ihrer Administratorkonsole erhalten werden kann.

Tauschen Sie benutzerdefinierte Token gegen ID und Aktualisierungstausch aus

Sie können ein benutzerdefiniertes Author -Token gegen eine ID austauschen und einen aktuellen Token aktualisieren, indem Sie eine HTTP POST an den Auth verifyCustomToken -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
Zeichen	Zeichenfolge	Ein FireBase Auth Custom -Token, aus dem ein ID erstellt und Token -Paar erstellt wird.
Rückkehrer	Boolescher Wert	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Ein Firebase Auth ID -Token, der aus dem bereitgestellten benutzerdefinierten Token generiert wurde.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth Refresh -Token, der aus dem bereitgestellten benutzerdefinierten Token erzeugt wird.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"token":"[CUSTOM_TOKEN]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts [CUSTOM_TOKEN] durch das generierte benutzerdefinierte Auth -Token ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält das Feuerbasis -ID -Token und das Aktualisierungstoken, das dem benutzerdefinierten Token zugeordnet ist.

Probenantwort

{
  "idToken": "[ID_TOKEN]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

Invaly_custom_token: Das benutzerdefinierte Token -Format ist falsch oder das Token ist aus irgendeinem Grund ungültig (z. B. abgelaufen, ungültige Signatur usw.)
CERMINTION_MISMATIK: Das benutzerdefinierte Token entspricht einem anderen Firebase -Projekt.

Tauschen Sie einen Refresh -Token gegen ein ID -Token aus

Sie können ein FireBase -ID -Token aktualisieren, indem Sie eine HTTP POST an den Endpoint securetoken.googleapis.com ausstellen.

HINWEIS: Standardmäßig bestätigt Google die Projektnummer Ihres Aktualisierungs -Tokens, um sicherzustellen, dass es der Ihrer API -Taste entspricht. Wenn die Projektnummer nicht übereinstimmt, erhalten Sie den Fehlercode PROJECT_NUMBER_MISMATCH . Diese Validierung mindert das potenzielle Risiko, dass Missbraucher Ihre API -Schlüssel sammeln, um Refresh -Token für ihre eigenen Projekte zu generieren. Wenn Sie das Risiko verstehen und dieses Verhalten abmelden möchten, können Sie eine Ausnahmeregelanfrage einreichen, indem Sie einen Google Cloud -Support -Fall einreichen.

Methode: POST

Inhaltstyp: Anwendung/x-www-form-urlencoded

Endpunkt

https://securetoken.googleapis.com/v1/token?key=[API_KEY]

Anfrage Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
Grant_type	Zeichenfolge	Der Zuschusstyp des Refresh -Tokens, immer "refresh_token".
refresh_token	Zeichenfolge	Ein Firebase Auth Refresh -Token.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.
token_type	Zeichenfolge	Der Typ des Refresh -Tokens, immer "Träger".
refresh_token	Zeichenfolge	Das Firebase Auth Refresh -Token, das in der Anfrage oder einem neuen Aktualisierungs -Token bereitgestellt wird.
id_token	Zeichenfolge	Ein Firebase Auth ID -Token.
Benutzer-ID	Zeichenfolge	Die UID entspricht dem bereitgestellten ID -Token.
project_id	Zeichenfolge	Ihre Firebase Project ID.

Musteranfrage

curl 'https://securetoken.googleapis.com/v1/token?key=[API_KEY]' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data 'grant_type=refresh_token&refresh_token=[REFRESH_TOKEN]'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres FireBase -Projekts [REFRESH_TOKEN] durch das Firebase Refresh -Token ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält das neue FireBase ID -Token und das Refresh -Token.

Probenantwort

{
  "expires_in": "3600",
  "token_type": "Bearer",
  "refresh_token": "[REFRESH_TOKEN]",
  "id_token": "[ID_TOKEN]",
  "user_id": "tRcfmLH7o2XrNELi...",
  "project_id": "1234567890"
}

Häufige Fehlercodes

Token_expired: Der Anmeldeinformator des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
User_disabled: Das Benutzerkonto wurde von einem Administrator deaktiviert.
User_not_found: Der Benutzer, der dem Refresh -Token entspricht, wurde nicht gefunden. Es ist wahrscheinlich, dass der Benutzer gelöscht wurde.
API -Schlüssel nicht gültig. Bitte übergeben Sie einen gültigen API -Schlüssel. (Ungültiger API -Schlüssel angegeben)
Invalid_refresh_Token: Es wird ein ungültiges Aktualisierungspunkt bereitgestellt.
Ungültige JSON -Nutzlast empfangen. Unbekannter Name \ "request_tokens \": Parameter des Abfrages kann nicht binden. Das Feld 'request_tokens' konnte in Anforderungsnachricht nicht gefunden werden.
Invaly_grant_type: Der angegebene Zuschusstyp ist ungültig.
Vermisster_refresh_token: Kein Aktualisierungstoken bereitgestellt.
Project_number_mismatch: Die Projektnummer des Refresh -Tokens stimmt nicht mit der der bereitgestellten API -Taste überein.

Melden Sie sich mit E -Mail / Passwort an

Sie können einen neuen E -Mail- und Kennwortbenutzer erstellen, indem Sie eine HTTP POST an den Auth signupNewUser -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	Die E -Mail für den Benutzer erstellen.
Passwort	Zeichenfolge	Das Passwort für den Benutzer zum Erstellen.
Rückkehrer	Boolescher Wert	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Ein Firebase Auth ID -Token für den neu erstellten Benutzer.
Email	Zeichenfolge	Die E -Mail für den neu erstellten Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase -Auth -Aktualisierungstoken für den neu erstellten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.
Local ID	Zeichenfolge	Die UID des neu erstellten Benutzers.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres FireBase -Projekts, [user@example.com] durch die E -Mail des neuen Benutzers und [PASSWORD] durch das Passwort des neuen Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält das Feuerbasis -ID -Token und das Aktualisierungstoken, das dem neuen Konto zugeordnet ist.

Probenantwort

{
  "idToken": "[ID_TOKEN]",
  "email": "[user@example.com]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "localId": "tRcfmLH7..."
}

Häufige Fehlercodes

E -Mail_Exists: Die E -Mail -Adresse wird bereits von einem anderen Konto verwendet.
Operation_NOT_Allowed: Für dieses Projekt ist die Kennwortanmeldung deaktiviert.
AUS_MANY_attempts_try_later: Wir haben alle Anfragen von diesem Gerät aufgrund ungewöhnlicher Aktivitäten blockiert. Versuchen Sie es später erneut.

Sie können sich in einem Benutzer mit einer E -Mail und einem Passwort anmelden, indem Sie eine HTTP POST an den Auth verifyPassword -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	Die E -Mail, mit der der Benutzer anmelden.
Passwort	Zeichenfolge	Das Passwort für das Konto.
Rückkehrer	Boolescher Wert	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Ein Firebase Auth ID -Token für den authentifizierten Benutzer.
Email	Zeichenfolge	Die E -Mail für den authentifizierten Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase -Auth -Aktualisierungstoken für den authentifizierten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.
Local ID	Zeichenfolge	Die UID des authentifizierten Benutzers.
Eingetragen	Boolescher Wert	Ob die E -Mail für ein vorhandenes Konto gilt.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[user@example.com]","password":"[PASSWORD]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres FireBase -Projekts [user@example.com] durch die E -Mail und das [PASSWORD] des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält das FireBase ID -Token und das Aktualisierung von Token, die dem vorhandenen E -Mail-/Passwort -Konto zugeordnet sind.

Probenantwort

{
  "localId": "ZY1rJK0eYLg...",
  "email": "[user@example.com]",
  "displayName": "",
  "idToken": "[ID_TOKEN]",
  "registered": true,
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

EMAIL_NOT_FOUND: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.
Invalid_password: Das Kennwort ist ungültig oder der Benutzer hat kein Kennwort.
User_disabled: Das Benutzerkonto wurde von einem Administrator deaktiviert.

Sie können sich anonym in einem Benutzer anmelden, indem Sie eine HTTP POST an den Auth signupNewUser -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
Rückkehrer	Boolescher Wert	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Ein Firebase Auth ID -Token für den neu erstellten Benutzer.
Email	Zeichenfolge	Da der Benutzer anonym ist, sollte dies leer sein.
Aktualisierungstoken	Zeichenfolge	Ein Firebase -Auth -Aktualisierungstoken für den neu erstellten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.
Local ID	Zeichenfolge	Die UID des neu erstellten Benutzers.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält das Firebase -ID -Token und das Aktualisierungstoken, das dem anonymen Benutzer zugeordnet ist.

Probenantwort

{
  "idToken": "[ID_TOKEN]",
  "email": "",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "localId": "Jws4SVjpT..."
}

Häufige Fehlercodes

Operation_NOT_Allowed: Anonymous Benutzeranmeldung ist für dieses Projekt deaktiviert.

Sie können sich in einem Benutzer mit einem OAuth -Anmeldeinformationen anmelden, indem Sie eine HTTP POST an den Auth verifyAssertion -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]

Anfrage Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
Requesturi	Zeichenfolge	Der URI, zu dem der IDP den Benutzer zurückleitet.
Postkörper	Zeichenfolge	Enthält die OAuth -Anmeldeinformationen (ein ID -Token oder ein Zugangs -Token) und eine Anbieter -ID, die den Anmeldeinformationen ausgibt.
Rückkehrer	Boolescher Wert	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht. Sollte immer wahr sein.
returnIdpcredential	Boolescher Wert	Ob die Rückgabe der OAuth -Anmeldeinformationen zu den folgenden Fehlern erzwingen soll: Federated_User_ID_Already_Linked und E -Mail_Exists.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
FederatedId	Zeichenfolge	Die eindeutige ID identifiziert das IDP -Konto.
Providerid	Zeichenfolge	Die verknüpfte Anbieter -ID (z. B. "Google.com" für den Google -Anbieter).
Local ID	Zeichenfolge	Die UID des authentifizierten Benutzers.
Email überprüft	Boolescher Wert	Ob die Anmeldung E-Mail überprüft wird.
Email	Zeichenfolge	Die E -Mail des Kontos.
oauthididtoken	Zeichenfolge	Das OIDC -ID -Token, falls verfügbar.
OAuthaccessToken	Zeichenfolge	Das OAuth Access -Token, falls verfügbar.
oaututhtokensecret	Zeichenfolge	Das OAuth 1.0 -Token -Geheimnis, falls verfügbar.
RAWUSERINFO	Zeichenfolge	Die angestrahlte JSON -Antwort, die alle IDP -Daten enthält, die dem bereitgestellten OAuth -Anmeldeinformationen entsprechen.
Vorname	Zeichenfolge	Der Vorname für das Konto.
Familienname, Nachname	Zeichenfolge	Der Nachname für das Konto.
vollständiger Name	Zeichenfolge	Der vollständige Name für das Konto.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
Photourl	Zeichenfolge	Die Foto -URL für das Konto.
idtoken	Zeichenfolge	Ein Firebase Auth ID -Token für den authentifizierten Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase -Auth -Aktualisierungstoken für den authentifizierten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.
NeedConfirmation	Boolescher Wert	Ob ein anderes Konto mit demselben Anmeldeinformationen bereits vorhanden ist. Der Benutzer muss sich beim ursprünglichen Konto anmelden und dann den aktuellen Anmeldeinformationen verknüpfen.

Beispielanforderung mit OAuth ID -Token

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres FireBase -Projekts [GOOGLE_ID_TOKEN] durch das Google OAuth -ID -Token, [google.com] durch die Anbieter -ID ersetzen, die dem OAuth -Anmeldeinformationen entspricht, und [http://localhost] mit der Anfrage URI.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält das Firebase -ID -Token und das Aktualisierungstoken, das dem authentifizierten Benutzer zugeordnet ist.

Beispielantwort mit OAuth ID -Token

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthIdToken": "[GOOGLE_ID_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Beispielanforderung mit OAuth Access Token

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres FireBase -Projekts [FACEBOOK_ACCESS_TOKEN] durch das Facebook Access Token, [facebook.com] durch die Anbieter -ID ersetzen, die dem OAUTH -Anmeldeinformationen entspricht, und [http://localhost] mit der Anfrage URI.

Beispielantwort mit OAuth Access Token

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://scontent.xx.fbcdn.net/v/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Beispielanforderung mit Twitter OAuth 1.0 Anmeldeinformationen

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres FireBase -Projekts [TWITTER_ACCESS_TOKEN] durch das Twitter OAuth Access -Token, [TWITTER_TOKEN_SECRET] mit dem Twitter OAuth -Token -Geheimnis, [twitter.com] mit der Provider -ID] ersetzen, [Twitter_Token_Secret] Entsprechend dem OAuth -Anmeldeinformationen und [http://localhost] mit der Anfrage URI.

Beispielantwort mit Twitter OAuth 1.0 Anmeldeinformationen

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]",
  "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "http://abs.twimg.com/sticky/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Häufige Fehlercodes

OPERT_NOT_ALLAWED: Der entsprechende Anbieter ist für dieses Projekt deaktiviert.
Invaly_idp_Response: Der angegebene Auth -Anmeldeinformat ist fehlerhaft oder ist abgelaufen.

Abrufen Anbieter für E -Mails ab

Sie können alle Anbieter ansehen, die mit einer bestimmten E -Mail verknüpft sind, indem Sie eine HTTP POST an den Auth createAuthUri -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
Identifikator	Zeichenfolge	E -Mail -Adresse des Benutzers
Fortsetzung	Zeichenfolge	Der URI, zu dem der IDP den Benutzer zurückleitet. Für diesen Anwendungsfall ist dies nur die aktuelle URL.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Alle Anbieter	Liste der Saiten	Die Liste der Anbieter, mit denen sich der Benutzer zuvor angemeldet hat.
Eingetragen	Boolescher Wert	Ob die E -Mail für ein vorhandenes Konto ist

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"identifier":"[user@example.com]","continueUri":"[http://localhost:8080/app]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres FireBase -Projekts [user@example.com] durch die E -Mail an Suchup und [http://localhost:8080/app] mit der aktuellen URL ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält die Liste der mit der E -Mail zugeordneten Anbieter.

Probenantwort

{
  "allProviders": [
    "password",
    "google.com"
  ],
  "registered": true
}

Häufige Fehlercodes

Invalid_email: Die E -Mail -Adresse ist schlecht formatiert.

Senden Sie eine E-Mail zum Zurücksetzen des Passworts

Sie können eine E -Mail mit Passwort zurücksetzen, indem Sie eine HTTP POST an den Endpunkt des Auth getOobConfirmationCode ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]

Optionale Header

Name des Anwesens	Beschreibung
X-Firebase-Locale	Der Sprachcode, der dem Gebietsschema des Benutzers entspricht. Durch das Übergeben lokalisieren die an den Benutzer gesendete E -Mail des Passworts zurückgesetzt.

Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
RequestType	Zeichenfolge	Die Art von OOB -Code, die zurückgegeben werden muss. Sollte "password_reset" für das Passwort zurückgesetzt werden.
Email	Zeichenfolge	E -Mail -Adresse des Benutzers.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	E -Mail -Adresse des Benutzers.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"requestType":"PASSWORD_RESET","email":"[user@example.com]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts [user@example.com] durch die E -Mail ersetzen, um das Passwort zurücksetzen zu können.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben.

Probenantwort

{
 "email": "[user@example.com]"
}

Häufige Fehlercodes

EMAIL_NOT_FOUND: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Überprüfen Sie den Code des Kennworts Reset

Sie können einen Code für das Zurücksetzen des Kennworts überprüfen, indem Sie eine HTTP POST an den Auth resetPassword -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]

Anfrage Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
Oobcode	Zeichenfolge	Der E -Mail -Aktionscode, der an die E -Mail des Benutzers gesendet wird, um das Kennwort zurückzusetzen.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	E -Mail -Adresse des Benutzers.
RequestType	Zeichenfolge	Typ des E -Mail -Aktionscode. Sollte "password_reset" sein.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"oobCode":"[PASSWORD_RESET_CODE]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts [PASSWORD_RESET_CODE] durch den Aktionscode für das Kennwort Reset ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben.

Probenantwort

{
  "email": "[user@example.com]",
  "requestType": "PASSWORD_RESET"
}

Häufige Fehlercodes

Operation_NOT_Allowed: Für dieses Projekt ist die Kennwortanmeldung deaktiviert.
Abgroßen_OOB_CODE: Der Aktionscode ist abgelaufen.
Invaly_oob_code: Der Aktionscode ist ungültig. Dies kann passieren, wenn der Code fehlerhaft, abgelaufen oder bereits verwendet wurde.

Bestätigen Sie das Zurücksetzen des Passworts

Sie können eine Änderung des Kennwortreset -Änderung anwenden, indem Sie eine HTTP POST auf den Endpunkt des Auth resetPassword ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
Oobcode	Zeichenfolge	Der E -Mail -Aktionscode, der an die E -Mail des Benutzers gesendet wird, um das Kennwort zurückzusetzen.
Neues Kennwort	Zeichenfolge	Das neue Passwort des Benutzers.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	E -Mail -Adresse des Benutzers.
RequestType	Zeichenfolge	Typ des E -Mail -Aktionscode. Sollte "password_reset" sein.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:resetPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"oobCode":"[PASSWORD_RESET_CODE]","newPassword":"[NEW_PASSWORD]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts, [PASSWORD_RESET_CODE] durch den Aktionscode für das Kennwort Reset ersetzen, und [NEW_PASSWORD] durch das neue Passwort des Benutzers.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben.

Probenantwort

{
  "email": "[user@example.com]",
  "requestType": "PASSWORD_RESET"
}

Häufige Fehlercodes

Operation_NOT_Allowed: Für dieses Projekt ist die Kennwortanmeldung deaktiviert.
Abgroßen_OOB_CODE: Der Aktionscode ist abgelaufen.
Invaly_oob_code: Der Aktionscode ist ungültig. Dies kann passieren, wenn der Code fehlerhaft, abgelaufen oder bereits verwendet wurde.
User_disabled: Das Benutzerkonto wurde von einem Administrator deaktiviert.

Ändern Sie die E-Mail

Sie können die E -Mail eines Benutzers ändern, indem Sie eine HTTP POST an den Auth setAccountInfo -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Optionale Header

Name des Anwesens	Beschreibung
X-Firebase-Locale	Der Sprachcode, der dem Gebietsschema des Benutzers entspricht. Wenn Sie dies übergeben, wird der an den Benutzer gesendete Widerruf der E -Mail -Änderung lokalisiert.

Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Ein Firebase -Auth -ID -Token für den Benutzer.
Email	Zeichenfolge	Die neue E -Mail des Benutzers.
Rückkehrer	Boolescher Wert	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	E -Mail -Adresse des Benutzers.
Passworthash	Zeichenfolge	Hash -Version des Passworts.
Provideruserinfo	Liste der JSON -Objekte	Liste aller verknüpften Anbieterobjekte, die "ProviderID" und "FederatedID" enthalten.
idtoken	Zeichenfolge	Neue Firebase Auth ID -Token für den Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth Refresh -Token.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[FIREBASE_ID_TOKEN]","email":"[user@example2.com]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts [FIREBASE_ID_TOKEN] durch das Firebase -ID -Token des Benutzers und [user@example2.com] ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält das neue FireBase -ID -Token und das mit dem Benutzer zugeordnete Aktualisierungstoken.

Probenantwort

{
  "localId": "tRcfmLH7o2...",
  "email": "[user@example2.com]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[user@example2.com]"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

E -Mail_Exists: Die E -Mail -Adresse wird bereits von einem anderen Konto verwendet.
Invaly_id_token: Der Anmeldeinformationseingabe des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.

Kennwort ändern

Sie können das Kennwort eines Benutzers ändern, indem Sie eine HTTP POST an den Auth setAccountInfo -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anfrage Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Ein Firebase -Auth -ID -Token für den Benutzer.
Passwort	Zeichenfolge	Neues Passwort des Benutzers.
Rückkehrer	Boolescher Wert	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	E -Mail -Adresse des Benutzers.
Passworthash	Zeichenfolge	Hash -Version des Passworts.
Provideruserinfo	Liste der JSON -Objekte	Liste aller verknüpften Anbieterobjekte, die "ProviderID" und "FederatedID" enthalten.
idtoken	Zeichenfolge	Neue Firebase Auth ID -Token für den Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth Refresh -Token.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[FIREBASE_ID_TOKEN]","password":"[NEW_PASSWORD]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts, [FIREBASE_ID_TOKEN] durch das Firebase -ID -Token des Benutzers und [NEW_PASSWORD] durch das neue Passwort des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält das neue FireBase -ID -Token und das mit dem Benutzer zugeordnete Aktualisierungstoken.

Probenantwort

{
  "localId": "tRcfmLH7o2...",
  "email": "[user@example.com]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[user@example.com]"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

Invaly_id_token: Der Anmeldeinformationseingabe des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
WACK_PASSWORD: Das Passwort muss 6 Zeichen lang oder mehr haben.

Profil aktualisieren

Sie können das Profil eines Benutzers (Anzeigename / Foto -URL) aktualisieren, indem Sie eine HTTP POST an den Auth setAccountInfo -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Ein Firebase -Auth -ID -Token für den Benutzer.
Anzeigename	Zeichenfolge	Neuer Anzeigename des Benutzers.
Photourl	Zeichenfolge	Neue Foto -URL des Benutzers.
DeleteEttribute	Liste der Saiten	Liste der zu löschenden Attribute, "display_name" oder "photo_url". Dies wird diese Werte annullieren.
Rückkehrer	Boolescher Wert	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	E -Mail -Adresse des Benutzers.
Anzeigename	Zeichenfolge	Neuer Anzeigename des Benutzers.
Photourl	Zeichenfolge	Neue Foto -URL des Benutzers.
Passworthash	Zeichenfolge	Hash -Version des Passworts.
Provideruserinfo	Liste der JSON -Objekte	Liste aller verknüpften Anbieterobjekte, die "ProviderID" und "FederatedID" enthalten.
idtoken	Zeichenfolge	Neue Firebase Auth ID -Token für den Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth Refresh -Token.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[ID_TOKEN]","displayName":"[NAME]","photoUrl":"[URL]","returnSecureToken":true}'

Im obigen Beispiel werden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts [ID_TOKEN] durch das Firebase -ID -Token des Benutzers ersetzen, [NAME] durch den neuen Anzeigenamen des Benutzers und [URL] mit der neuen Fotolurl des Benutzers .

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben.

Probenantwort

{
  "localId": "tRcfmLH...",
  "email": "user@example2.com",
  "displayName": "John Doe",
  "photoUrl": "[http://localhost:8080/img1234567890/photo.png]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example2.com",
      "displayName": "John Doe",
      "photoUrl": "http://localhost:8080/img1234567890/photo.png"
    }
  ],
  "idToken": "[NEW_ID_TOKEN]",
  "refreshToken": "[NEW_REFRESH_TOKEN]",
  "expiresIn": "3600"
}

Häufige Fehlercodes

Invaly_id_token: Der Anmeldeinformationseingabe des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.

Nutzungsdaten abrufen

Sie können die Daten eines Benutzers abrufen, indem Sie eine HTTP POST an den Auth getAccountInfo -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]

Anfrage Körpernutzlast Anfrage

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Das Firebase ID -Token des Kontos.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Benutzer	Liste der JSON -Objekte	Das mit dem angegebene Firebase ID -Token zugeordnete Konto. Weitere Einzelheiten finden Sie weiter unten.

Antwortnutzlast ( users -Inhalt)

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	Die E -Mail des Kontos.
Email überprüft	Boolescher Wert	Ob die E -Mail des Kontos überprüft wurde oder nicht.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
Provideruserinfo	Liste der JSON -Objekte	Liste aller verknüpften Anbieterobjekte, die "ProviderID" und "FederatedID" enthalten.
Photourl	Zeichenfolge	Die Foto -URL für das Konto.
Passworthash	Zeichenfolge	Hash -Version des Passworts.
passwordUpdatedat	doppelt	Der Zeitstempel in Millisekunden, dass das Kontokennwort zuletzt geändert wurde.
gültig	Zeichenfolge	Der Zeitstempel in Sekunden, der eine Grenze markiert, vor der Firebase ID -Token als widerrufen angesehen wird.
deaktiviert	Boolescher Wert	Ob das Konto deaktiviert ist oder nicht.
lastloginat	Zeichenfolge	Der Zeitstempel in Millisekunden, den das Konto zuletzt angemeldet hat.
hergestellt in	Zeichenfolge	Der Zeitstempel in Millisekunden, in dem das Konto erstellt wurde.
CustomAuth	Boolescher Wert	Ob das Konto vom Entwickler authentifiziert wird.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:lookup?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts und [FIREBASE_ID_TOKEN] durch das Firebase -ID -Token des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben. Die Antwort enthält alle mit dem Konto zugeordneten Benutzerinformationen.

Probenantwort

{
  "users": [
    {
      "localId": "ZY1rJK0...",
      "email": "user@example.com",
      "emailVerified": false,
      "displayName": "John Doe",
      "providerUserInfo": [
        {
          "providerId": "password",
          "displayName": "John Doe",
          "photoUrl": "http://localhost:8080/img1234567890/photo.png",
          "federatedId": "user@example.com",
          "email": "user@example.com",
          "rawId": "user@example.com",
          "screenName": "user@example.com"
        }
      ],
      "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
      "passwordHash": "...",
      "passwordUpdatedAt": 1.484124177E12,
      "validSince": "1484124177",
      "disabled": false,
      "lastLoginAt": "1484628946000",
      "createdAt": "1484124142000",
      "customAuth": false
    }
  ]
}

Häufige Fehlercodes

Invaly_id_token: Der Anmeldeinformationseingabe des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
User_not_found: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Link mit E -Mail/Passwort

Sie können eine E -Mail/ein Passwort mit einem aktuellen Benutzer verknüpfen, indem Sie eine HTTP POST mit dem Auth setAccountInfo -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anfrage Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Das Firebase -ID -Token des Kontos, mit dem Sie den Anmeldeinformationen verknüpfen möchten.
Email	Zeichenfolge	Die E -Mail zum Link zum Konto.
Passwort	Zeichenfolge	Das neue Passwort des Kontos.
Rückkehrer	Zeichenfolge	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht. Sollte immer wahr sein.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	Die E -Mail des Kontos.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
Photourl	Zeichenfolge	Die Foto -URL für das Konto.
Passworthash	Zeichenfolge	Hash -Version des Passworts.
Provideruserinfo	Liste der JSON -Objekte	Liste aller verknüpften Anbieterobjekte, die "ProviderID" und "FederatedID" enthalten.
Email überprüft	Boolescher Wert	Ob die E -Mail des Kontos überprüft wurde oder nicht.
idtoken	Zeichenfolge	Neue Firebase Auth ID -Token für den Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase Auth Refresh -Token.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[ID_TOKEN]","email":"[user@example.com]","password":"[PASS]","returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts [ID_TOKEN] durch das Firebase -ID -Token des Benutzers ersetzen, [user@example.com] durch die E -Mail des Benutzers, die verknüpft und [Pass) werden muss und [PASS] mit dem Passwort, das verknüpft werden muss.

Probenantwort

{
  "localId": "huDwUz...",
  "email": "user@example.com",
  "displayName": "John Doe",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ],
  "idToken": "[ID_TOKEN]",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "emailVerified": false
}

Häufige Fehlercodes

Anmeldeinformationen_TOO_OLD_LOGIN_AGAIN: Der Anmeldeinformator des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
Token_expired: Der Anmeldeinformator des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
Invaly_id_token: Der Anmeldeinformationseingabe des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
WACK_PASSWORD: Das Passwort muss 6 Zeichen lang oder mehr haben.

Link mit OAuth -Anmeldeinformationen

Sie können eine OAuth -Anmeldeinformation mit einem Benutzer verknüpfen, indem Sie eine HTTP POST an den Auth verifyAssertion -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Das Firebase -ID -Token des Kontos, mit dem Sie den Anmeldeinformationen verknüpfen möchten.
Requesturi	Zeichenfolge	Der URI, zu dem der IDP den Benutzer zurückleitet.
Postkörper	Zeichenfolge	Enthält die OAuth -Anmeldeinformationen (ein ID -Token oder ein Zugangs -Token) und eine Anbieter -ID, die den Anmeldeinformationen ausgibt.
Rückkehrer	Boolescher Wert	Ob eine ID zurücksenden und nicht aktualisiert werden soll oder nicht. Sollte immer wahr sein.
returnIdpcredential	Boolescher Wert	Ob die Rückgabe der OAuth -Anmeldeinformationen zu den folgenden Fehlern erzwingen soll: Federated_User_ID_Already_Linked und E -Mail_Exists.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
FederatedId	Zeichenfolge	Die eindeutige ID identifiziert das IDP -Konto.
Providerid	Zeichenfolge	Die verknüpfte Anbieter -ID (z. B. "Google.com" für den Google -Anbieter).
Local ID	Zeichenfolge	Die UID des authentifizierten Benutzers.
Email überprüft	Boolescher Wert	Ob die Signin -E -Mail überprüft wird.
Email	Zeichenfolge	Die E -Mail des Kontos.
oauthididtoken	Zeichenfolge	Das OIDC -ID -Token, falls verfügbar.
OAuthaccessToken	Zeichenfolge	Das OAuth Access -Token, falls verfügbar.
oaututhtokensecret	Zeichenfolge	Das OAuth 1.0 -Token -Geheimnis, falls verfügbar.
RAWUSERINFO	Zeichenfolge	Die angestrahlte JSON -Antwort, die alle IDP -Daten enthält, die dem bereitgestellten OAuth -Anmeldeinformationen entsprechen.
Vorname	Zeichenfolge	Der Vorname für das Konto.
Familienname, Nachname	Zeichenfolge	Der Nachname für das Konto.
vollständiger Name	Zeichenfolge	Der vollständige Name für das Konto.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
Photourl	Zeichenfolge	Die Foto -URL für das Konto.
idtoken	Zeichenfolge	Ein Firebase Auth ID -Token für den authentifizierten Benutzer.
Aktualisierungstoken	Zeichenfolge	Ein Firebase -Auth -Aktualisierungstoken für den authentifizierten Benutzer.
Läuft ab in	Zeichenfolge	Die Anzahl der Sekunden, in denen das ID -Token abläuft.

Beispielanforderung mit OAuth ID -Token

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"id_token=[GOOGLE_ID_TOKEN]&providerId=[google.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase [google.com] [FIREBASE_ID_TOKEN] [GOOGLE_ID_TOKEN] das Firebase -ID -Token des aktuellen Benutzers ersetzen ID entsprechend dem OAuth -Anmeldeinformat und [http://localhost] mit der Anfrage URI.

Beispielantwort mit OAuth ID -Token

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthIdToken": "[GOOGLE_ID_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Beispielanforderung mit OAuth Access Token

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=[facebook.com]","idToken":"[FIREBASE_ID_TOKEN]","requestUri":"[http://localhost]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [facebook.com] [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts [FIREBASE_ID_TOKEN] [FACEBOOK_ACCESS_TOKEN] den Firebase -ID -Token des aktuellen Benutzers ersetzen Entsprechend dem OAuth -Anmeldeinformationen und [http://localhost] mit der Anfrage URI.

Beispielantwort mit OAuth Access Token

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[FACEBOOK_ACCESS_TOKEN]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "https://scontent.xx.fbcdn.net/v/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Beispielanforderung mit Twitter OAuth 1.0 Anmeldeinformationen

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithIdp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"postBody":"access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret=[TWITTER_TOKEN_SECRET]&providerId=[twitter.com]","requestUri":"[http://localhost]","idToken":"[FIREBASE_ID_TOKEN]","returnIdpCredential":true,"returnSecureToken":true}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres FireBase -Projekts [FIREBASE_ID_TOKEN] durch das Firebase -ID -Token des aktuellen Benutzers ersetzen, [TWITTER_ACCESS_TOKEN] mit dem Twitter OAuth Access -Token, [TWITTER_TOKEN_SECRET] mit dem Twitter OAauth token token token token Geheimnis, [twitter.com] mit der Anbieter -ID, die dem OAuth -Anmeldeinformationen und [http://localhost] mit der Anfrage URI entspricht.

Beispielantwort mit Twitter OAuth 1.0 Anmeldeinformationen

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "user@example.com",
  "oauthAccessToken": "[OAUTH_ACCESS_TOKEN]",
  "oauthTokenSecret": "[OAUTH_TOKEN_SECRET]",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "displayName": "John Doe",
  "idToken": "[ID_TOKEN]",
  "photoUrl": "http://abs.twimg.com/sticky/...",
  "refreshToken": "[REFRESH_TOKEN]",
  "expiresIn": "3600",
  "rawUserInfo": "{\"updated_time\":\"2017-02-22T01:10:57+0000\",\"gender\":\"male\", ...}"
}

Häufige Fehlercodes

OPERT_NOT_ALLAWED: Der entsprechende Anbieter ist für dieses Projekt deaktiviert.
Invaly_idp_Response: Der angegebene Auth -Anmeldeinformat ist fehlerhaft oder ist abgelaufen.
Invaly_id_token: Der Anmeldeinformationseingabe des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
E -Mail_Exists: Die E -Mail -Adresse wird bereits von einem anderen Konto verwendet.
Federated_user_id_already_linked: Dieser Anmeldeinformator ist bereits einem anderen Benutzerkonto zugeordnet.

Anbieter des Unglieds

Sie können einen Anbieter von einem aktuellen Benutzer entfernen, indem Sie eine HTTP POST an den Auth setAccountInfo -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Das Firebase ID -Token des Kontos.
Löschen	Liste der Saiten	Die Liste der Anbieter -IDs zum Verenden, z. B. "Google.com", "Passwort", usw.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Local ID	Zeichenfolge	Die UID des aktuellen Benutzers.
Email	Zeichenfolge	Die E -Mail des Kontos.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
Photourl	Zeichenfolge	Die Foto -URL für das Konto.
Passworthash	Zeichenfolge	Hash -Version des Passworts.
Provideruserinfo	Liste der JSON -Objekte	Liste aller verknüpften Anbieterobjekte, die "ProviderID" und "FederatedID" enthalten.
Email überprüft	Boolescher Wert	Ob die E -Mail des Kontos überprüft wurde oder nicht.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"idToken":"[FIREBASE_ID_TOKEN]","deleteProvider":["[facebook.com]"]}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts, [FIREBASE_ID_TOKEN] durch das Firebase -ID -Token des Benutzers und [facebook.com] durch die Anbieter -ID ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben.

Probenantwort

{
  "localId": "huDwUz...",
  "email": "user@example.com",
  "displayName": "John Doe",
  "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "google.com",
      "federatedId": "1234567890",
      "displayName": "John Doe",
      "photoUrl": "https://lh5.googleusercontent.com/.../photo.jpg"
    },
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ],
  "emailVerified": "true"
}

Häufige Fehlercodes

Invaly_id_token: Der Anmeldeinformationseingabe des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.

E -Mail -Überprüfung senden

Sie können eine E -Mail -Überprüfung für den aktuellen Benutzer senden, indem Sie eine HTTP POST an den Endpunkt des Auth getOobConfirmationCode ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]

Optionale Header

Name des Anwesens	Beschreibung
X-Firebase-Locale	Der Sprachcode, der dem Gebietsschema des Benutzers entspricht. Wenn Sie dies übergeben, wird die an den Benutzer gesendete E -Mail -Überprüfung lokalisiert.

Körpernutzlast anfordern

Name des Anwesens	Typ	Beschreibung
RequestType	Zeichenfolge	Die Art des Sendens von Bestätigungscode. Sollte immer "verify_email" sein.
idtoken	Zeichenfolge	Das Firebase -ID -Token des Benutzers zu überprüfen.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	Die E -Mail des Kontos.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"requestType":"VERIFY_EMAIL","idToken":"[FIREBASE_ID_TOKEN]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts und [FIREBASE_ID_TOKEN] durch das Firebase ID -Token des aktuellen Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben.

Probenantwort

{
  "email": "user@example.com"
}

Häufige Fehlercodes

Invaly_id_token: Der Anmeldeinformationseingabe des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
User_not_found: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Bestätigen Sie die E -Mail -Überprüfung

Sie können einen E -Mail -Überprüfungscode bestätigen, indem Sie eine HTTP POST an den Auth setAccountInfo -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
Oobcode	Zeichenfolge	Der Aktionscode, der an die E -Mail des Benutzers gesendet wurde, um die E -Mail -Überprüfung zu erhalten.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
Email	Zeichenfolge	Die E -Mail des Kontos.
Anzeigename	Zeichenfolge	Der Anzeigename für das Konto.
Photourl	Zeichenfolge	Die Foto -URL für das Konto.
Passworthash	Zeichenfolge	Das Passwort Hash.
Provideruserinfo	Liste der JSON -Objekte	Liste aller verknüpften Anbieterobjekte, die "ProviderID" und "FederatedID" enthalten.
Email überprüft	Boolescher Wert	Ob die E -Mail des Kontos überprüft wurde oder nicht.

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"oobCode":"[VERIFICATION_CODE]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts und [VERIFICATION_CODE] durch den E -Mail -Verifizierungscode ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben.

Probenantwort

{
  "localId": "FhyStE...",
  "email": "user@example.com",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "user@example.com"
    }
  ]
}

Häufige Fehlercodes

Abgroßen_OOB_CODE: Der Aktionscode ist abgelaufen.
Invaly_oob_code: Der Aktionscode ist ungültig. Dies kann passieren, wenn der Code fehlerhaft, abgelaufen oder bereits verwendet wurde.
User_disabled: Das Benutzerkonto wurde von einem Administrator deaktiviert.
EMAIL_NOT_FOUND: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Konto löschen

Sie können einen aktuellen Benutzer löschen, indem Sie eine HTTP POST an den Auth deleteAccount -Endpunkt ausgeben.

Methode: POST

Inhaltstyp: application/json

Endpunkt

https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
idtoken	Zeichenfolge	Das Firebase -ID -Token des Benutzers zu löschen.

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung

Musteranfrage

curl 'https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"idToken":"[FIREBASE_ID_TOKEN]"}'

Im obigen Beispiel würden Sie [API_KEY] durch den Web -API -Schlüssel Ihres Firebase -Projekts und [FIREBASE_ID_TOKEN] durch das Firebase -ID -Token des Benutzers ersetzen.

Eine erfolgreiche Anfrage wird durch einen 200 OK HTTP -Statuscode angegeben.

Häufige Fehlercodes

Invaly_id_token: Der Anmeldeinformationseingabe des Benutzers ist nicht mehr gültig. Der Benutzer muss sich erneut anmelden.
User_not_found: Es gibt keinen Benutzerdatensatz, der dieser Kennung entspricht. Der Benutzer wurde möglicherweise gelöscht.

Firebase Authentication Emulator

Die Firebase Local Emulator Suite enthält einen Authentifizierungs -Emulator , der zum lokalen Prototyping und Testen von Authentifizierungsflüssen verwendet werden kann. Der Emulator enthält die folgenden REST -Endpunkte.

HTTP ist erforderlich. Verbindungen zum Emulator sind auf localhost und der Emulator unterstützt keine Verschlüsselung.

Benutzerkonten löschen

Entfernen Sie alle Konten im angegebenen Projekt unabhängig vom Staat.

Methode: DELETE

Endpunkt

Beachten Sie, dass 9099 der Standardport für den Authentifizierungsemulator ist. Überprüfen Sie die Anschlussausgabe für den verwendeten Port.

http://localhost:9099/emulator/v1/projects/{project-id}/accounts

Rufen Sie die Emulatorkonfiguration ab

Holen Sie sich die Emulator-spezifische Konfiguration für das angegebene Projekt.

Methode: GET

Endpunkt

Beachten Sie, dass 9099 der Standardport für den Authentifizierungsemulator ist. Überprüfen Sie die Anschlussausgabe für den verwendeten Port.

http://localhost:9099/emulator/v1/projects/{project-id}/config

Antwortnutzlast

Name des Anwesens	Typ	Beschreibung
anmelden	Objekt	Signin -Konfigurationsobjekt, das einen einzelnen Taste enthält, `allowDuplicateEmails` (boolean).

Patch -Emulator -Konfiguration

Aktualisieren Sie die emulatorspezifische Konfiguration für das angegebene Projekt.

Methode: Patch

Endpunkt

Beachten Sie, dass 9099 der Standardport für den Authentifizierungsemulator ist. Überprüfen Sie die Anschlussausgabe für den verwendeten Port.

Inhaltstyp: application/json

http://localhost:9099/emulator/v1/projects/{project-id}/config

Anfrage Körpernutzlast

Name des Anwesens	Typ	Beschreibung
anmelden	Objekt	Gewünschtes Signin -Konfigurationsobjekt mit einzelnen Schlüssel, `allowDuplicateEmails` (boolean).

Response Payload

Name des Anwesens	Typ	Beschreibung
anmelden	Objekt	Post-request signIn configuration object with single key, `allowDuplicateEmails` (boolean).

Retrieve out-of-band authentication codes

If the authentication flows you are testing would normally generate out-of-band codes (eg, email verification codes, password reset codes), the emulator stores such codes internally until they are used.

Methode: GET

Endpunkt

Note that 9099 is the default port for the Authentication emulator. Check terminal output for the actual port being used.

http://localhost:9099/emulator/v1/projects/{project-id}/oobCodes

Response Payload

Name des Anwesens	Typ	Beschreibung
oobCodes	Array	An array of objects containing details of all pending confirmation codes. Each object contains `email` (string), `oobCode` (string), `oobLink` (string), and `requestType` (string)

Retrieve SMS verification codes

If you are testing phone/SMS authentication flows, the emulator stores such SMS codes internally until they are used.

Methode: GET

Endpunkt

Note that 9099 is the default port for the Authentication emulator. Check terminal output for the actual port being used.

http://localhost:9099/emulator/v1/projects/{project-id}/verificationCodes

Response Payload

Name des Anwesens	Typ	Beschreibung
verificationCodes	Array	An array of objects containing details of all pending verification codes. Each object contains `phoneNumber` (string) and `sessionCode` (string).

Error Response

Error response format

Anytime an error is returned from the backend server for any of the APIs above, the response will have the following format.

Sample response

{
  "error": {
    "errors": [
      {
        "domain": "global",
        "reason": "invalid",
        "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN"
      }
    ],
    "code": 400,
    "message": "CREDENTIAL_TOO_OLD_LOGIN_AGAIN"
  }
}

The error code is obtained from the message field. All of the above error codes refer to the message field content.

Firebase Auth-REST-API

API-Nutzung

Tauschen Sie das benutzerdefinierte Token gegen eine ID und ein Aktualisierungstoken aus

Tauschen Sie einen Aktualisierungstoken gegen einen ID-Token aus

Melden Sie sich mit E-Mail/Passwort an

Melden Sie sich mit E-Mail/Passwort an

Anonym anmelden

Melden Sie sich mit OAuth-Anmeldeinformationen an

Anbieter für E-Mail abrufen

Senden Sie eine E-Mail zum Zurücksetzen des Passworts

Überprüfen Sie den Code zum Zurücksetzen des Passworts

Bestätigen Sie das Zurücksetzen des Passworts

Ändern Sie die E-Mail

Kennwort ändern

Profil aktualisieren

Benutzerdaten abrufen

Link mit E-Mail/Passwort

Verknüpfung mit OAuth-Anmeldeinformationen

Verknüpfung mit dem Anbieter aufheben

E-Mail-Bestätigung senden

Bestätigen Sie die E-Mail-Bestätigung

Konto löschen

Firebase-Authentifizierungsemulator

Benutzerkonten löschen

Rufen Sie die Emulatorkonfiguration ab

Patch-Emulator-Konfiguration

Rufen Sie Out-of-Band-Authentifizierungscodes ab

Rufen Sie SMS-Bestätigungscodes ab

Fehlerantwort

Fehlerantwortformat

API-Nutzung

Tauschen Sie benutzerdefinierte Token gegen ID und Aktualisierungstausch aus

Tauschen Sie einen Refresh -Token gegen ein ID -Token aus

Melden Sie sich mit E -Mail / Passwort an

Melden Sie sich mit E -Mail / Passwort an

Anonym anmelden

Melden Sie sich bei OAuth Referentin an

Abrufen Anbieter für E -Mails ab

Senden Sie eine E-Mail zum Zurücksetzen des Passworts

Überprüfen Sie den Code des Kennworts Reset

Bestätigen Sie das Zurücksetzen des Passworts

Ändern Sie die E-Mail

Kennwort ändern

Profil aktualisieren

Nutzungsdaten abrufen

Link mit E -Mail/Passwort

Link mit OAuth -Anmeldeinformationen

Anbieter des Unglieds

E -Mail -Überprüfung senden

Bestätigen Sie die E -Mail -Überprüfung

Konto löschen

Firebase Authentication Emulator

Benutzerkonten löschen

Rufen Sie die Emulatorkonfiguration ab

Patch -Emulator -Konfiguration

Retrieve out-of-band authentication codes

Retrieve SMS verification codes

Error Response

Error response format