Utiliser l'API REST

Échanger un jeton personnalisé contre un ID 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 signInWithCustomToken.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

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 Identity Platform et le jeton d'actualisation associé 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, expiration, signature non valide, etc.).
• CREDENTIAL_MISMATCH: le jeton personnalisé correspond à un autre projet Google Cloud.

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

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

Méthode : POST

Content-Type : (Type-contenu) application/x-www-form-urlencoded

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

Exemple de demande

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'ID Identity Platform 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 : l'identifiant de l'utilisateur n'est plus valide. 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 est introuvable. Le compte utilisateur a probablement été supprimé.
• Clé API non valide. Veuillez transmettre une clé API valide. (clé d'API fournie non valide)
• INVALID_REFRESH_TOKEN : jeton d'actualisation fourni non valide.
• 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 requête.
• INVALID_GRANT_TYPE: le type d'attribution 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.

S'inscrire avec une adresse e-mail/un mot de passe

Vous pouvez créer un utilisateur d'adresse e-mail et de mot de passe en envoyant une requête POST HTTP au point de terminaison signupNewUser d'authentification.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[[email protected]]","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'ID Identity Platform et le jeton d'actualisation associés au nouveau compte.

Exemple de réponse

{
  "idToken": "[ID_TOKEN]",
  "email": "[[email protected]]",
  "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 requêtes provenant de cet appareil en raison d'une activité inhabituelle. Réessayez plus tard.

Se connecter avec une adresse e-mail/un mot de passe

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

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

curl 'https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"email":"[[email protected]]","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'ID Identity Platform et le jeton d'actualisation associés au compte de messagerie/mot de passe existant.

Exemple de réponse

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

Codes d'erreur courants

• EMAIL_NOT_FOUND : aucun enregistrement d'utilisateur ne correspond à cet identifiant. L'utilisateur a peut-être été supprimé.
• INVALID_PASSWORD : le mot de passe n'est pas valide ou l'utilisateur n'en possède pas.
• USER_DISABLED : le compte utilisateur a été désactivé par un administrateur.

Se connecter de manière anonyme

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

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

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'ID Identity Platform 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 d'utilisateur anonyme est désactivée pour ce projet.

Se connecter avec un identifiant OAuth

Vous pouvez connecter un utilisateur avec un identifiant OAuth en envoyant une requête POST HTTP au point de terminaison verifyAssertion d'authentification.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de requête avec un jeton d'ID 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'ID Identity Platform et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec jeton d'ID OAuth

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "[email protected]",
  "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 un 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'ID Identity Platform et le jeton d'actualisation associés à l'utilisateur authentifié.

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

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "[email protected]",
  "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 requête avec l'identifiant 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'ID Identity Platform et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec identifiant Twitter OAuth 1.0

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "[email protected]",
  "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 : l'identifiant d'authentification fourni est incorrect ou a expiré.

Extraire des fournisseurs pour l'adresse

Pour rechercher tous les fournisseurs associés à une adresse e-mail spécifiée, envoyez une requête POST HTTP au point de terminaison createAuthUri d'authentification.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

curl 'https://identitytoolkit.googleapis.com/v1/accounts:createAuthUri?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"identifier":"[[email protected]]","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'adresse e-mail.

Exemple de réponse

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

Codes d'erreur courants

• INVALID_EMAIL : le format de l'adresse e-mail n'est pas correctement formaté.

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

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

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

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

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

Exemple de réponse

{
 "email": "[[email protected]]"
}

Codes d'erreur courants

• EMAIL_NOT_FOUND : aucun enregistrement d'utilisateur ne correspond à cet identifiant. L'utilisateur a peut-être été supprimé.

Valider le code de réinitialisation de mot de passe

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

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

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": "[[email protected]]",
  "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. Cette erreur peut se produire si le code n'est pas correctement formaté, a expiré ou a déjà été utilisé.

Confirmer la réinitialisation du mot de passe

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

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

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": "[[email protected]]",
  "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. Cette erreur peut se produire si le code n'est pas correctement formaté, a expiré ou a déjà été utilisé.
• USER_DISABLED : le compte utilisateur a été désactivé par un administrateur.

Modifier l'adresse e-mail

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

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[GCIP_ID_TOKEN]","email":"[[email protected]]","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'ID Identity Platform et le jeton d'actualisation associé à l'utilisateur.

Exemple de réponse

{
  "localId": "tRcfmLH7o2...",
  "email": "[[email protected]]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[[email protected]]"
    }
  ],
  "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 identifiants de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.

Modifier le mot de passe

Pour modifier le mot de passe d'un utilisateur, envoyez une requête POST HTTP au point de terminaison setAccountInfo d'authentification.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[GCIP_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'ID Identity Platform et le jeton d'actualisation associé à l'utilisateur.

Exemple de réponse

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

Codes d'erreur courants

• INVALID_ID_TOKEN : les identifiants de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• WEAK_PASSWORD : le mot de passe doit comporter au moins 6 caractères.

Mettre à jour le profil

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

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

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": "[email protected]",
  "displayName": "John Doe",
  "photoUrl": "[http://localhost:8080/img1234567890/photo.png]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[email protected]",
      "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 identifiants de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.

Obtenir des données utilisateur

Pour obtenir les données d'un utilisateur, envoyez une requête POST HTTP au point de terminaison getAccountInfo d'authentification.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

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

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

Exemple de réponse

{
  "users": [
    {
      "localId": "ZY1rJK0...",
      "email": "[email protected]",
      "emailVerified": false,
      "displayName": "John Doe",
      "providerUserInfo": [
        {
          "providerId": "password",
          "displayName": "John Doe",
          "photoUrl": "http://localhost:8080/img1234567890/photo.png",
          "federatedId": "[email protected]",
          "email": "[email protected]",
          "rawId": "[email protected]",
          "screenName": "[email protected]"
        }
      ],
      "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 identifiants de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• USER_NOT_FOUND : aucun enregistrement d'utilisateur ne correspond à cet identifiant. L'utilisateur a peut-être été supprimé.

Associer avec l'adresse e-mail/le mot de passe

Vous pouvez associer une adresse e-mail/un mot de passe à un utilisateur actuel en envoyant une requête POST HTTP au point de terminaison setAccountInfo d'authentification.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary \
'{"idToken":"[ID_TOKEN]","email":"[[email protected]]","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'ID Identity Platform et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse

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

Codes d'erreur courants

• CREDENTIAL_TOO_OLD_LOGIN_AGAIN : l'identifiant de l'utilisateur n'est plus valide. L'utilisateur doit se reconnecter.
• TOKEN_EXPIRED : l'identifiant de l'utilisateur n'est plus valide. L'utilisateur doit se reconnecter.
• INVALID_ID_TOKEN : les identifiants de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• WEAK_PASSWORD : le mot de passe doit comporter au moins 6 caractères.

Association avec l'identifiant OAuth

Vous pouvez associer un identifiant OAuth à un utilisateur en envoyant une requête POST HTTP au point de terminaison verifyAssertion d'authentification.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de requête avec un jeton d'ID 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":"[GCIP_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'ID Identity Platform et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec jeton d'ID OAuth

{
  "federatedId": "https://accounts.google.com/1234567890",
  "providerId": "google.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "[email protected]",
  "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 un 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":"[GCIP_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'ID Identity Platform et le jeton d'actualisation associés à l'utilisateur authentifié.

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

{
  "federatedId": "http://facebook.com/1234567890",
  "providerId": "facebook.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "[email protected]",
  "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 requête avec l'identifiant 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":"[GCIP_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'ID Identity Platform et le jeton d'actualisation associés à l'utilisateur authentifié.

Exemple de réponse avec identifiant Twitter OAuth 1.0

{
  "federatedId": "http://twitter.com/1234567890",
  "providerId": "twitter.com",
  "localId": "5xwsPCWYo...",
  "emailVerified": true,
  "email": "[email protected]",
  "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 : l'identifiant d'authentification fourni est incorrect ou a expiré.
• INVALID_ID_TOKEN : les identifiants 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 un fournisseur

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

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

curl 'https://identitytoolkit.googleapis.com/v1/accounts:update?key=[API_KEY]' \
-H 'Content-Type: application/json' \
--data-binary '{"idToken":"[GCIP_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": "[email protected]",
  "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": "[email protected]"
    }
  ],
  "emailVerified": "true"
}

Codes d'erreur courants

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

Envoyer la validation d'adresse e-mail

Vous pouvez envoyer une validation d'adresse e-mail pour l'utilisateur actuel en envoyant une requête POST HTTP au point de terminaison getOobConfirmationCode d'authentification.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

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

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

Exemple de réponse

{
  "email": "[email protected]"
}

Codes d'erreur courants

• INVALID_ID_TOKEN : les identifiants de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• USER_NOT_FOUND : aucun enregistrement d'utilisateur ne correspond à cet identifiant. L'utilisateur a peut-être été supprimé.

Confirmer la validation d'adresse e-mail

Vous pouvez confirmer un code de validation d'adresse e-mail en envoyant une requête POST HTTP au point de terminaison setAccountInfo d'authentification.

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

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": "[email protected]",
  "passwordHash": "...",
  "providerUserInfo": [
    {
      "providerId": "password",
      "federatedId": "[email protected]"
    }
  ]
}

Codes d'erreur courants

• EXPIRED_OOB_CODE : le code d'action a expiré.
• INVALID_OOB_CODE : le code d'action n'est pas valide. Cette erreur peut se produire si le code n'est pas correctement formaté, a expiré ou a déjà été utilisé.
• USER_DISABLED : le compte utilisateur a été désactivé par un administrateur.
• EMAIL_NOT_FOUND : aucun enregistrement d'utilisateur ne correspond à cet identifiant. L'utilisateur a peut-être été supprimé.

Supprimer le compte

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

Méthode : POST

Content-Type : (Type-contenu) = application/json

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

Exemple de demande

curl 'https://identitytoolkit.googleapis.com/v1/accounts:delete?key=[API_KEY]' \
-H 'Content-Type: application/json' --data-binary '{"idToken":"[GCIP_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 identifiants de l'utilisateur ne sont plus valides. L'utilisateur doit se reconnecter.
• USER_NOT_FOUND : aucun enregistrement d'utilisateur ne correspond à cet identifiant. L'utilisateur a peut-être été supprimé.