API REST d'authentification Firebase

Échangez un jeton personnalisé contre un identifiant et un jeton d'actualisation

Vous pouvez échanger un jeton d'authentification personnalisé contre un ID et un jeton d'actualisation en envoyant une requête HTTP POST au point de terminaison Auth verifyCustomToken .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'ID Firebase et le jeton d'actualisation associés au jeton personnalisé.

Exemple de réponse

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

Codes d'erreur courants

• INVALID_CUSTOM_TOKEN : le format du jeton personnalisé est incorrect ou le jeton n'est pas valide pour une raison quelconque (par exemple, signature expirée, non valide, etc.)
• CREDENTIAL_MISMATCH : le jeton personnalisé correspond à un autre projet Firebase.

Échanger un jeton d'actualisation contre un jeton d'identification

Vous pouvez actualiser un jeton d'identification Firebase en envoyant une requête HTTP POST au point de terminaison securetoken.googleapis.com .

Méthode : POST

Type de contenu : application/x-www-form-urlencoded

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

Demande d'échantillon

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]'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le nouveau jeton d'identification Firebase et le jeton d'actualisation.

Exemple de réponse

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

Codes d'erreur courants

• TOKEN_EXPIRED : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• USER_DISABLED : Le compte utilisateur a été désactivé par un administrateur.
• USER_NOT_FOUND : L'utilisateur correspondant au jeton d'actualisation n'a pas été trouvé. Il est probable que l'utilisateur ait été supprimé.
• Clé API non valide. Veuillez transmettre une clé API valide. (clé API non valide fournie)
• INVALID_REFRESH_TOKEN : un jeton d'actualisation non valide est fourni.
• Charge utile JSON non valide reçue. Nom inconnu \"refresh_tokens\" : Impossible de lier le paramètre de requête. Le champ « refresh_tokens » est introuvable dans le message de demande.
• INVALID_GRANT_TYPE : le type d'octroi spécifié n'est pas valide.
• MISSING_REFRESH_TOKEN : aucun jeton d'actualisation fourni.
• PROJECT_NUMBER_MISMATCH : le numéro de projet du jeton d'actualisation ne correspond pas à celui de la clé API fournie.

Inscrivez-vous avec email / mot de passe

Vous pouvez créer un nouvel utilisateur de messagerie et de mot de passe en envoyant une requête HTTP POST au point de terminaison Auth signupNewUser .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés au nouveau compte.

Exemple de réponse

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

Codes d'erreur courants

• EMAIL_EXISTS : L'adresse e-mail est déjà utilisée par un autre compte.
• OPERATION_NOT_ALLOWED : la connexion par mot de passe est désactivée pour ce projet.
• TOO_MANY_ATTEMPTS_TRY_LATER : Nous avons bloqué toutes les demandes provenant de cet appareil en raison d'une activité inhabituelle. Réessayez plus tard.

Connectez-vous avec email / mot de passe

Vous pouvez connecter un utilisateur avec une adresse e-mail et un mot de passe en envoyant une requête HTTP POST au point de terminaison Auth verifyPassword .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés au compte de messagerie/mot de passe existant.

Exemple de réponse

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

Codes d'erreur courants

• EMAIL_NOT_FOUND : Il n'existe aucune fiche utilisateur correspondant à cet identifiant. L'utilisateur a peut-être été supprimé.
• INVALID_PASSWORD : Le mot de passe n'est pas valide ou l'utilisateur n'a pas de mot de passe.
• USER_DISABLED : Le compte utilisateur a été désactivé par un administrateur.

Connectez-vous de manière anonyme

Vous pouvez connecter un utilisateur de manière anonyme en envoyant une requête HTTP POST au point de terminaison Auth signupNewUser .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur anonyme.

Exemple de réponse

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

Codes d'erreur courants

• OPERATION_NOT_ALLOWED : la connexion des utilisateurs anonymes est désactivée pour ce projet.

Connectez-vous avec les informations d'identification OAuth

Vous pouvez connecter un utilisateur avec des informations d'identification OAuth en envoyant une requête HTTP POST au point de terminaison Auth verifyAssertion .

Méthode : POST

Type de contenu : application/json

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

Exemple de requête avec jeton d'identification OAuth

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec le jeton d'identification OAuth

{
  "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\", ...}"
}

Exemple de requête avec jeton d'accès OAuth

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec le jeton d'accès OAuth

{
  "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\", ...}"
}

Exemple de demande avec les informations d'identification Twitter OAuth 1.0

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec les informations d'identification Twitter OAuth 1.0

{
  "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\", ...}"
}

Codes d'erreur courants

• OPERATION_NOT_ALLOWED : le fournisseur correspondant est désactivé pour ce projet.
• INVALID_IDP_RESPONSE : les informations d'identification d'authentification fournies sont mal formées ou ont expiré.

Récupérer les fournisseurs pour le courrier électronique

Vous pouvez rechercher tous les fournisseurs associés à un e-mail spécifié en envoyant une requête HTTP POST au point de terminaison Auth createAuthUri .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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]"}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient la liste des fournisseurs associés à l'e-mail.

Exemple de réponse

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

Codes d'erreur courants

• INVALID_EMAIL : L'adresse e-mail est mal formatée.

Envoyer un e-mail de réinitialisation du mot de passe

Vous pouvez envoyer un e-mail de réinitialisation de mot de passe en envoyant une requête HTTP POST au point de terminaison Auth getOobConfirmationCode .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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]"}'

Une demande réussie est indiquée par un code d'état HTTP 200 OK .

Exemple de réponse

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

Codes d'erreur courants

• EMAIL_NOT_FOUND : Il n'existe aucune fiche utilisateur correspondant à cet identifiant. L'utilisateur a peut-être été supprimé.

Vérifier le code de réinitialisation du mot de passe

Vous pouvez vérifier un code de réinitialisation de mot de passe en envoyant une requête HTTP POST au point de terminaison Auth resetPassword .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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

Une requête réussie est indiquée par un code d'état HTTP 200 OK .

Exemple de réponse

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

Codes d'erreur courants

• OPERATION_NOT_ALLOWED : la connexion par mot de passe est désactivée pour ce projet.
• EXPIRED_OOB_CODE : le code d'action a expiré.
• INVALID_OOB_CODE : le code d'action n'est pas valide. Cela peut se produire si le code est mal formé, a expiré ou a déjà été utilisé.

Confirmer la réinitialisation du mot de passe

Vous pouvez appliquer une modification de réinitialisation de mot de passe en envoyant une requête HTTP POST au point de terminaison Auth resetPassword .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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]"}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK .

Exemple de réponse

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

Codes d'erreur courants

• OPERATION_NOT_ALLOWED : la connexion par mot de passe est désactivée pour ce projet.
• EXPIRED_OOB_CODE : le code d'action a expiré.
• INVALID_OOB_CODE : le code d'action n'est pas valide. Cela peut se produire si le code est mal formé, a expiré ou a déjà été utilisé.
• USER_DISABLED : Le compte utilisateur a été désactivé par un administrateur.

Changer l'e-mail

Vous pouvez modifier l'adresse e-mail d'un utilisateur en envoyant une requête HTTP POST au point de terminaison Auth setAccountInfo .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le nouveau jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur.

Exemple de réponse

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

Codes d'erreur courants

• EMAIL_EXISTS : L'adresse e-mail est déjà utilisée par un autre compte.
• INVALID_ID_TOKEN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.

Changer le mot de passe

Vous pouvez modifier le mot de passe d'un utilisateur en envoyant une requête HTTP POST au point de terminaison Auth setAccountInfo .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le nouveau jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur.

Exemple de réponse

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

Codes d'erreur courants

• INVALID_ID_TOKEN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• WEAK_PASSWORD : Le mot de passe doit comporter 6 caractères ou plus.

Mettre à jour le profil

Vous pouvez mettre à jour le profil d'un utilisateur (nom d'affichage/URL de la photo) en envoyant une requête HTTP POST au point de terminaison Auth setAccountInfo .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK .

Exemple de réponse

{
  "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"
}

Codes d'erreur courants

• INVALID_ID_TOKEN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.

Obtenir les données utilisateur

Vous pouvez obtenir les données d'un utilisateur en envoyant une requête HTTP POST au point de terminaison Auth getAccountInfo .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contiendra toutes les informations utilisateur associées au compte.

Exemple de réponse

{
  "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
    }
  ]
}

Codes d'erreur courants

• INVALID_ID_TOKEN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• USER_NOT_FOUND : Il n'existe aucune fiche utilisateur correspondant à cet identifiant. L'utilisateur a peut-être été supprimé.

Lien avec email/mot de passe

Vous pouvez lier un e-mail/un mot de passe à un utilisateur actuel en envoyant une requête HTTP POST au point de terminaison Auth setAccountInfo .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse

{
  "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
}

Codes d'erreur courants

• CREDENTIAL_TOO_OLD_LOGIN_AGAIN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• TOKEN_EXPIRED : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• INVALID_ID_TOKEN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• WEAK_PASSWORD : Le mot de passe doit comporter 6 caractères ou plus.

Lien avec les informations d'identification OAuth

Vous pouvez lier un identifiant OAuth à un utilisateur en envoyant une requête HTTP POST au point de terminaison Auth verifyAssertion .

Méthode : POST

Type de contenu : application/json

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

Exemple de requête avec jeton d'identification OAuth

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec le jeton d'identification OAuth

{
  "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\", ...}"
}

Exemple de requête avec jeton d'accès OAuth

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec le jeton d'accès OAuth

{
  "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\", ...}"
}

Exemple de demande avec les informations d'identification Twitter OAuth 1.0

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}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK . La réponse contient le jeton d'identification Firebase et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec les informations d'identification Twitter OAuth 1.0

{
  "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\", ...}"
}

Codes d'erreur courants

• OPERATION_NOT_ALLOWED : le fournisseur correspondant est désactivé pour ce projet.
• INVALID_IDP_RESPONSE : les informations d'identification d'authentification fournies sont mal formées ou ont expiré.
• INVALID_ID_TOKEN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• EMAIL_EXISTS : L'adresse e-mail est déjà utilisée par un autre compte.
• FEDERATED_USER_ID_ALREADY_LINKED : cet identifiant est déjà associé à un autre compte utilisateur.

Dissocier le fournisseur

Vous pouvez dissocier un fournisseur d'un utilisateur actuel en envoyant une requête HTTP POST au point de terminaison Auth setAccountInfo .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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]"]}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK .

Exemple de réponse

{
  "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"
}

Codes d'erreur courants

• INVALID_ID_TOKEN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.

Envoyer une vérification par e-mail

Vous pouvez envoyer une vérification par e-mail pour l'utilisateur actuel en envoyant une requête HTTP POST au point de terminaison Auth getOobConfirmationCode .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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]"}'

Une requête réussie est indiquée par un code d'état HTTP 200 OK .

Exemple de réponse

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

Codes d'erreur courants

• INVALID_ID_TOKEN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• USER_NOT_FOUND : Il n'existe aucune fiche utilisateur correspondant à cet identifiant. L'utilisateur a peut-être été supprimé.

Confirmer la vérification par e-mail

Vous pouvez confirmer un code de vérification d'e-mail en envoyant une requête HTTP POST au point de terminaison Auth setAccountInfo .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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

Une requête réussie est indiquée par un code d'état HTTP 200 OK .

Exemple de réponse

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

Codes d'erreur courants

• EXPIRED_OOB_CODE : le code d'action a expiré.
• INVALID_OOB_CODE : le code d'action n'est pas valide. Cela peut se produire si le code est mal formé, a expiré ou a déjà été utilisé.
• USER_DISABLED : Le compte utilisateur a été désactivé par un administrateur.
• EMAIL_NOT_FOUND : Il n'existe aucune fiche utilisateur correspondant à cet identifiant. L'utilisateur a peut-être été supprimé.

Supprimer le compte

Vous pouvez supprimer un utilisateur actuel en envoyant une requête HTTP POST au point de terminaison Auth deleteAccount .

Méthode : POST

Type de contenu : application/json

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

Demande d'échantillon

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

Une requête réussie est indiquée par un code d'état HTTP 200 OK .

Codes d'erreur courants

• INVALID_ID_TOKEN : les informations d'identification de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• USER_NOT_FOUND : Il n'existe aucune fiche utilisateur correspondant à cet identifiant. L'utilisateur a peut-être été supprimé.

Effacer les comptes d'utilisateurs

Supprimez tous les comptes du projet spécifié, quel que soit leur état.

Méthode : SUPPRIMER

Notez que 9099 est le port par défaut de l'émulateur d'authentification. Vérifiez la sortie du terminal pour le port réellement utilisé.

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

Obtenir la configuration de l'émulateur

Obtenez la configuration spécifique à l'émulateur pour le projet spécifié.

Méthode : OBTENIR

Notez que 9099 est le port par défaut de l'émulateur d'authentification. Vérifiez la sortie du terminal pour le port réellement utilisé.

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

Configuration de l'émulateur de correctifs

Mettez à jour la configuration spécifique à l’émulateur pour le projet spécifié.

Méthode : PATCH

Notez que 9099 est le port par défaut de l'émulateur d'authentification. Vérifiez la sortie du terminal pour le port réellement utilisé.

Type de contenu : application/json

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

Récupérer les codes d'authentification hors bande

Si les flux d'authentification que vous testez généreraient normalement des codes hors bande (par exemple, les codes de vérification par e-mail, les codes de réinitialisation du mot de passe), l'émulateur stocke ces codes en interne jusqu'à ce qu'ils soient utilisés.

Méthode: obtenir

Notez que 9099 est le port par défaut pour l'émulateur d'authentification. Vérifiez la sortie du terminal pour le port réel utilisé.

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

Récupérer les codes de vérification SMS

Si vous testez les flux d'authentification téléphonique / SMS, l'émulateur stocke ces codes SMS en interne jusqu'à ce qu'ils soient utilisés.

Méthode: obtenir

Notez que 9099 est le port par défaut pour l'émulateur d'authentification. Vérifiez la sortie du terminal pour le port réel utilisé.

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

Format de réponse d'erreur

Chaque fois qu'une erreur est renvoyée du serveur backend pour l'une des API ci-dessus, la réponse aura le format suivant.

Exemple de réponse

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

Le code d'erreur est obtenu à partir du champ Message. Tous les codes d'erreur ci-dessus se réfèrent au contenu du champ de message.