Documentation de référence de l'API JavaScript Se connecter avec Google

Cette page de référence décrit l'API JavaScript de connexion. Vous pouvez utiliser cette API pour afficher l'invite "Un appui" ou le bouton "Se connecter avec Google" sur vos pages Web.

Méthode: google.accounts.id.initialize

La méthode google.accounts.id.initialize initialise le client de connexion avec Google en fonction de l'objet de configuration. Consultez l'exemple de code suivant de la méthode:

google.accounts.id.initialize(IdConfiguration)

L'exemple de code suivant implémente la méthode google.accounts.id.initialize avec une fonction onload:

<script>
  window.onload = function () {
    google.accounts.id.initialize({
      client_id: 'YOUR_GOOGLE_CLIENT_ID',
      callback: handleCredentialResponse
    });
    google.accounts.id.prompt();
  };
</script>

La méthode google.accounts.id.initialize crée une instance de client Se connecter avec Google qui peut être implicitement utilisée par tous les modules d'une même page Web.

• Vous ne devez appeler la méthode google.accounts.id.initialize qu'une seule fois, même si vous utilisez plusieurs modules (comme One Tap, le bouton personnalisé, la révocation, etc.) sur la même page Web.
• Si vous appelez la méthode google.accounts.id.initialize plusieurs fois, seules les configurations du dernier appel sont mémorisées et utilisées.

Vous réinitialisez en fait les configurations chaque fois que vous appelez la méthode google.accounts.id.initialize, et toutes les méthodes ultérieures de la même page Web utilisent immédiatement les nouvelles configurations.

Type de données: IdConfiguration

Le tableau suivant répertorie les champs et les descriptions du type de données IdConfiguration:

client_id

Ce champ correspond à l'ID client de votre application, qui se trouve et est créé dans la console Google Cloud. Pour en savoir plus, consultez le tableau suivant:

auto_select

Ce champ détermine si un jeton d'ID est automatiquement renvoyé sans aucune interaction utilisateur lorsqu'une seule session Google a approuvé votre application auparavant. La valeur par défaut est false. Pour en savoir plus, consultez le tableau suivant:

rappel

Ce champ est la fonction JavaScript qui gère le jeton d'ID renvoyé par l'invite One Tap ou la fenêtre pop-up. Cet attribut est obligatoire si le mode UX Google One Tap ou le bouton Se connecter avec Google popup est utilisé. Pour en savoir plus, consultez le tableau suivant:

login_uri

Cet attribut correspond à l'URI de votre point de terminaison de connexion.

La valeur doit correspondre exactement à l'un des URI de redirection autorisés pour le client OAuth 2.0, que vous avez configuré dans la console Google Cloud et doit respecter nos règles de validation des URI de redirection.

Cet attribut peut être omis si la page actuelle est votre page de connexion, auquel cas les identifiants sont publiés sur cette page par défaut.

La réponse des identifiants du jeton d'ID est publiée sur votre point de terminaison de connexion lorsqu'un utilisateur clique sur le bouton "Se connecter avec Google" et que le mode d'expérience utilisateur de redirection est utilisé.

Pour en savoir plus, consultez le tableau suivant:

Votre point de terminaison de connexion doit gérer les requêtes POST contenant une clé credential avec une valeur de jeton d'ID dans le corps.

Voici un exemple de requête envoyée à votre point de terminaison de connexion:

POST /login HTTP/1.1
Host: www.example.com
Content-Type: application/x-www-form-urlencoded

credential=ID_TOKEN

native_callback

Ce champ correspond au nom de la fonction JavaScript qui gère les identifiants de mot de passe renvoyés par le gestionnaire d'identifiants natif du navigateur. Pour en savoir plus, consultez le tableau suivant:

cancel_on_tap_outside

Ce champ indique si la demande de paiement sans contact doit être annulée ou non si un utilisateur clique en dehors de l'invite. La valeur par défaut est true. Vous pouvez la désactiver en définissant la valeur sur false. Pour en savoir plus, consultez le tableau suivant:

prompt_parent_id

Cet attribut définit l'ID DOM de l'élément conteneur. Si ce n'est pas le cas, l'invite "Un appui" s'affiche en haut à droite de la fenêtre. Pour en savoir plus, consultez le tableau suivant:

nonce

Ce champ est une chaîne aléatoire utilisée par le jeton d'ID pour empêcher les attaques par rejeu. Pour en savoir plus, consultez le tableau suivant:

La longueur de la nonce est limitée à la taille maximale de JWT prise en charge par votre environnement, ainsi qu'aux contraintes de taille HTTP du navigateur et du serveur individuels.

context

Ce champ modifie le texte du titre et des messages dans l'invite One Tap. Pour en savoir plus, consultez le tableau suivant:

Le tableau suivant répertorie tous les contextes disponibles et leurs descriptions:

state_cookie_domain

Si vous devez afficher One Tap dans le domaine parent et ses sous-domaines, transmettez le domaine parent à ce champ afin qu'un seul cookie d'état partagé soit utilisé. Pour en savoir plus, consultez le tableau suivant:

ux_mode

Utilisez ce champ pour définir le flux d'expérience utilisateur utilisé par le bouton "Se connecter avec Google". La valeur par défaut est popup. Cet attribut n'a aucune incidence sur l'expérience utilisateur OneTap. Pour en savoir plus, consultez le tableau suivant:

Le tableau suivant répertorie les modes d'expérience utilisateur disponibles et leurs descriptions.

allowed_parent_origin

Origines autorisées à intégrer l'iFrame intermédiaire. One Tap s'exécute en mode iframe intermédiaire si ce champ est présent. Pour en savoir plus, consultez le tableau suivant:

Le tableau suivant répertorie les types de valeurs acceptés et leurs descriptions.

Les préfixes génériques sont également acceptés. Par exemple, "https://*.example.com" correspond à example.com et à ses sous-domaines à tous les niveaux (par exemple, news.example.com, login.news.example.com). À retenir lorsque vous utilisez des caractères génériques:

• Les chaînes de modèle ne peuvent pas être composées uniquement d'un caractère générique et d'un domaine de premier niveau. Par exemple, https://.com et https://.co.uk ne sont pas valides. Comme indiqué ci-dessus, "https://.example.com" correspond à example.com et à ses sous-domaines. Vous pouvez également utiliser un tableau pour représenter deux domaines différents. Par exemple, ["https://example1.com", "https://.example2.com"] correspond aux domaines example1.com, example2.com et aux sous-domaines de example2.com.
• Les domaines avec des caractères génériques doivent commencer par un schéma https:// sécurisé. "*.example.com" est donc considéré comme non valide.

Si la valeur du champ allowed_parent_origin n'est pas valide, l'initialisation One Tap du mode iFrame intermédiaire échouera et s'arrêtera.

intermediate_iframe_close_callback

Force le comportement par défaut de l'iframe intermédiaire lorsque les utilisateurs ferment manuellement One Tap en appuyant sur le bouton "X" dans l'interface utilisateur de One Tap. Le comportement par défaut consiste à supprimer immédiatement l'iFrame intermédiaire du DOM.

Le champ intermediate_iframe_close_callback ne prend effet qu'en mode iFrame intermédiaire. Et cela n'a d'impact que sur l'iframe intermédiaire, et non sur l'iframe One Tap. L'UI One Tap est supprimée avant l'appel du rappel.

itp_support

Ce champ détermine si l' expérience utilisateur One Tap mise à niveau doit être activée sur les navigateurs compatibles avec la prévention intelligente du suivi (ITP). La valeur par défaut est false. Pour en savoir plus, consultez le tableau suivant:

login_hint

Si votre application sait à l'avance quel utilisateur doit être connecté, elle peut fournir un indice de connexion à Google. Si l'opération aboutit, la sélection du compte est ignorée. Valeurs acceptées: adresse e-mail ou valeur du champ sub du jeton d'ID.

Pour en savoir plus, consultez la section concernant le champ login_hint dans la documentation OpenID Connect.

HD

Lorsqu'un utilisateur possède plusieurs comptes et ne doit se connecter qu'avec son compte Workspace, utilisez cette option pour fournir un indice de nom de domaine à Google. Si l'opération aboutit, les comptes utilisateur affichés lors de la sélection du compte sont limités au domaine fourni. Valeur générique: * n'offre que des comptes Workspace à l'utilisateur et exclut les comptes grand public (user@gmail.com) lors de la sélection du compte.

Pour en savoir plus, consultez le champ hd dans la documentation OpenID Connect.

use_fedcm_for_prompt

Autorisez le navigateur à contrôler les invites de connexion des utilisateurs et à arbitrer le flux de connexion entre votre site Web et Google. Valeur par défaut : "false". Pour en savoir plus, consultez la page Migrer vers FedCM.

enable_redirect_uri_validation

Activez le flux de redirection de bouton conforme aux Règles de validation des URI de redirection.

Méthode: google.accounts.id.prompt

La méthode google.accounts.id.prompt affiche l'invite One Tap ou le gestionnaire d'identifiants natif du navigateur après l'appel de la méthode initialize(). Consultez l'exemple de code suivant de la méthode:

 google.accounts.id.prompt(/**
 @type{(function(!PromptMomentNotification):void)=} */ momentListener)

Normalement, la méthode prompt() est appelée lors du chargement de la page. En raison de l'état de la session et des paramètres utilisateur côté Google, l'UI de l'invite avec un seul geste peut ne pas s'afficher. Pour recevoir des notifications sur l'état de l'UI à différents moments, transmettez une fonction pour recevoir des notifications sur l'état de l'UI.

Les notifications sont déclenchées aux moments suivants:

• Moment d'affichage:cette étape se produit après l'appel de la méthode prompt(). La notification contient une valeur booléenne indiquant si l'interface utilisateur est affichée ou non.

• Moment ignoré:cela se produit lorsque l'invite de connexion avec un seul geste est fermée par une résiliation automatique, une résiliation manuelle ou lorsque Google ne parvient pas à émettre d'identifiants, par exemple lorsque la session sélectionnée s'est déconnectée de Google.

  Dans ce cas, nous vous recommandons de passer aux fournisseurs d'identité suivants, le cas échéant.

• Moment de rejet:cela se produit lorsque Google récupère un identifiant ou qu'un utilisateur souhaite arrêter le processus de récupération des identifiants. Par exemple, lorsque l'utilisateur commence à saisir son nom d'utilisateur et son mot de passe dans la boîte de dialogue de connexion, vous pouvez appeler la méthode google.accounts.id.cancel() pour fermer l'invite avec un seul geste et déclencher un moment de rejet.

L'exemple de code suivant implémente le moment ignoré:

<script>
  window.onload = function () {
    google.accounts.id.initialize(...);
    google.accounts.id.prompt((notification) => {
      if (notification.isNotDisplayed() || notification.isSkippedMoment()) {
        // continue with another identity provider.
      }
    });
  };
</script>

Type de données: PromptMomentNotification

Le tableau suivant répertorie les méthodes et les descriptions du type de données PromptMomentNotification:

Type de données: CredentialResponse

Lorsque votre fonction callback est appelée, un objet CredentialResponse est transmis en tant que paramètre. Le tableau suivant liste les champs contenus dans l'objet de réponse des identifiants:

identifiant

Ce champ correspond au jeton d'identification sous la forme d'une chaîne de jeton Web JSON (JWT) encodée en base64.

Une fois décodé, le jeton JWT se présente comme suit:

header
{
  "alg": "RS256",
  "kid": "f05415b13acb9590f70df862765c655f5a7a019e", // JWT signature
  "typ": "JWT"
}
payload
{
  "iss": "https://accounts.google.com", // The JWT's issuer
  "nbf":  161803398874,
  "aud": "314159265-pi.apps.googleusercontent.com", // Your server's client ID
  "sub": "3141592653589793238", // The unique ID of the user's Google Account
  "hd": "gmail.com", // If present, the host domain of the user's GSuite email address
  "email": "elisa.g.beckett@gmail.com", // The user's email address
  "email_verified": true, // true, if Google has verified the email address
  "azp": "314159265-pi.apps.googleusercontent.com",
  "name": "Elisa Beckett",
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/e2718281828459045235360uler",
  "given_name": "Elisa",
  "family_name": "Beckett",
  "iat": 1596474000, // Unix timestamp of the assertion's creation time
  "exp": 1596477600, // Unix timestamp of the assertion's expiration time
  "jti": "abc161803398874def"
}

Le champ sub est un identifiant unique global pour le compte Google. Utilisez uniquement le champ sub comme identifiant de l'utilisateur, car il est unique pour tous les comptes Google et n'est jamais réutilisé. N'utilisez pas l'adresse e-mail comme identifiant, car un compte Google peut être associé à plusieurs adresses e-mail à différents moments.

Les champs email, email_verified et hd vous permettent de déterminer si Google héberge une adresse e-mail et s'il est l'autorité compétente. Lorsque Google est l'autorité compétente, l'utilisateur est confirmé comme étant le propriétaire légitime du compte.

Cas où Google est l'autorité compétente:

• email comporte le suffixe @gmail.com. Il s'agit d'un compte Gmail.
• Si email_verified est défini sur "true" et que hd est défini, il s'agit d'un compte Google Workspace.

Les utilisateurs peuvent créer des comptes Google sans utiliser Gmail ni Google Workspace. Lorsque email ne contient pas de suffixe @gmail.com et que hd n'est pas défini, Google n'est pas primaire, et un mot de passe ou d'autres méthodes d'authentification sont recommandés pour valider l'utilisateur. email_verfied peut également être vrai, car Google a initialement validé l'utilisateur lors de la création du compte Google. Toutefois, la propriété du compte de messagerie tiers peut avoir changé depuis.

Le champ exp indique l'heure d'expiration pour que vous puissiez valider le jeton côté serveur. Il s'agit d'une heure pour le jeton d'ID obtenu à partir de Se connecter avec Google. Vous devez valider le jeton avant la date d'expiration. N'utilisez pas exp pour la gestion des sessions. Un jeton d'ID expiré ne signifie pas que l'utilisateur est déconnecté. Votre application est responsable de la gestion des sessions de vos utilisateurs.

select_by

Le tableau suivant répertorie les valeurs possibles pour le champ select_by. Le type de bouton utilisé avec l'état de la session et de l'état du consentement sert à définir la valeur,

• L'utilisateur a appuyé sur le bouton One Tap ou Se connecter avec Google, ou a utilisé le processus de connexion automatique sans contact.

• Une session existante a été détectée, ou l'utilisateur a sélectionné un compte Google et s'est connecté pour établir une nouvelle session.

• Avant de partager les identifiants du jeton d'identité avec votre application, l'utilisateur doit :

  • a appuyé sur le bouton "Confirmer" pour autoriser le partage des identifiants ; ou
  • avait déjà donné son consentement et utilisé "Sélectionner un compte" pour choisir un compte Google.

La valeur de ce champ est définie sur l'un des types suivants :

state

Ce champ n'est défini que lorsque l'utilisateur clique sur un bouton "Se connecter avec Google" pour se connecter, et que l'attribut state du bouton cliqué est spécifié. La valeur de ce champ est identique à celle que vous avez spécifiée dans l'attribut state du bouton.

Étant donné que plusieurs boutons "Se connecter avec Google" peuvent s'afficher sur la même page, vous pouvez attribuer à chaque bouton une chaîne unique. Vous pouvez donc utiliser ce champ state pour identifier le bouton sur lequel l'utilisateur a cliqué pour se connecter.

Méthode: google.accounts.id.renderButton

La méthode google.accounts.id.renderButton affiche un bouton "Se connecter avec Google" dans vos pages Web.

Consultez l'exemple de code suivant de la méthode:

google.accounts.id.renderButton(
      /** @type{!HTMLElement} */ parent,
      /** @type{!GsiButtonConfiguration} */ options
    )

Type de données: GsiButtonConfiguration

Le tableau suivant répertorie les champs et les descriptions du type de données GsiButtonConfiguration:

Types d'attributs

Les sections suivantes contiennent des informations sur le type de chaque attribut et un exemple.

type

Type de bouton. La valeur par défaut est standard.

Pour en savoir plus, consultez le tableau suivant:

Le tableau suivant répertorie les types de boutons disponibles et leur description:

Type
standard
icon

thème

Thème du bouton La valeur par défaut est outline. Pour en savoir plus, consultez le tableau suivant:

Le tableau suivant répertorie les thèmes disponibles et leurs descriptions:

Thème
outline
filled_blue
filled_black

taille

Taille du bouton. La valeur par défaut est large. Pour en savoir plus, consultez le tableau suivant:

Le tableau suivant répertorie les tailles de boutons disponibles et leurs descriptions:

Taille
large
medium
small

texte

Texte du bouton. La valeur par défaut est signin_with. Il n'y a aucune différence visuelle pour le texte des boutons d'icônes qui ont des attributs text différents. La seule exception concerne la lecture du texte à des fins d'accessibilité.

Pour en savoir plus, consultez le tableau suivant:

Le tableau suivant répertorie tous les textes de bouton disponibles et leur description:

Texte
signin_with
signup_with
continue_with
signin

shape

Forme du bouton. La valeur par défaut est rectangular. Pour en savoir plus, consultez le tableau suivant:

Le tableau suivant présente les formes de boutons disponibles et leur description:

Forme
rectangular
pill
circle
square

logo_alignment

L'alignement du logo Google. La valeur par défaut est left. Cet attribut ne s'applique qu'au type de bouton standard. Pour en savoir plus, consultez le tableau suivant:

Le tableau suivant répertorie les alignements disponibles et leur description:

logo_alignment
left
center

largeur

Largeur minimale du bouton, en pixels. La largeur maximale est de 400 pixels.

Pour en savoir plus, consultez le tableau suivant:

locale

Facultatif. Affiche le texte du bouton dans la langue spécifiée. Sinon, les paramètres du navigateur ou du compte Google de l'utilisateur sont utilisés par défaut. Ajoutez le paramètre hl et le code de langue à l'instruction src lors du chargement de la bibliothèque, par exemple : gsi/client?hl=<iso-639-code>.

Si ce paramètre n'est pas défini, les paramètres régionaux par défaut du navigateur ou les préférences de l'utilisateur de la session Google sont utilisés. Par conséquent, différents utilisateurs peuvent voir différentes versions des boutons localisés, et éventuellement de différentes tailles.

Pour en savoir plus, consultez le tableau suivant:

click_listener

Vous pouvez définir une fonction JavaScript à appeler lorsque l'utilisateur clique sur le bouton "Se connecter avec Google" à l'aide de l'attribut click_listener.

  google.accounts.id.renderButton(document.getElementById("signinDiv"), {
      theme: 'outline',
      size: 'large',
      click_listener: onClickHandler
    });

  
  function onClickHandler(){
    console.log("Sign in with Google button clicked...")
  }
  

Dans cet exemple, le message Se connecter avec le bouton "Se connecter avec Google" a cliqué... est enregistré dans la console lorsque l'utilisateur clique sur le bouton "Se connecter avec Google".

state

Facultatif : comme plusieurs boutons "Se connecter avec Google" peuvent être affichés sur la même page, vous pouvez attribuer une chaîne unique à chaque bouton. La même chaîne est renvoyée avec le jeton d'ID afin que vous puissiez identifier le bouton sur lequel l'utilisateur a cliqué pour se connecter.

Pour en savoir plus, consultez le tableau suivant:

Type de données: identifiant

Lorsque votre fonction native_callback est appelée, un objet Credential est transmis en tant que paramètre. Le tableau suivant liste les champs contenus dans l'objet:

Méthode: google.accounts.id.disableAutoSelect

Lorsque l'utilisateur se déconnecte de votre site Web, vous devez appeler la méthode google.accounts.id.disableAutoSelect pour enregistrer l'état dans les cookies. Cela permet d'éviter une boucle morte de l'expérience utilisateur. Consultez l'extrait de code suivant de la méthode:

google.accounts.id.disableAutoSelect()

L'exemple de code suivant implémente la méthode google.accounts.id.disableAutoSelect avec une fonction onSignout():

<script>
  function onSignout() {
    google.accounts.id.disableAutoSelect();
  }
</script>

Méthode: google.accounts.id.storeCredential

Cette méthode est un wrapper pour la méthode store() de l'API du gestionnaire d'identifiants natif du navigateur. Par conséquent, il ne peut être utilisé que pour stocker des identifiants de mot de passe. Consultez l'exemple de code suivant de la méthode:

google.accounts.id.storeCredential(Credential, callback)

L'exemple de code suivant implémente la méthode google.accounts.id.storeCredential avec une fonction onSignIn():

<script>
  function onSignIn() {
    let cred = {id: '...', password: '...'};
    google.accounts.id.storeCredential(cred);
  }
</script>

Méthode: google.accounts.id.cancel

Vous pouvez annuler le parcours One Tap si vous supprimez l'invite du DOM du tiers de confiance. L'opération d'annulation est ignorée si des identifiants sont déjà sélectionnés. Consultez l'exemple de code suivant de la méthode:

google.accounts.id.cancel()

L'exemple de code suivant implémente la méthode google.accounts.id.cancel() avec une fonction onNextButtonClicked():

<script>
  function onNextButtonClicked() {
    google.accounts.id.cancel();
    showPasswordPage();
  }
</script>

Rappel de chargement de la bibliothèque: onGoogleLibraryLoad

Vous pouvez enregistrer un rappel onGoogleLibraryLoad. Il est averti une fois la bibliothèque JavaScript Se connecter avec Google chargée:

window.onGoogleLibraryLoad = () => {
    ...
};

Ce rappel n'est qu'un raccourci pour le rappel window.onload. Il n'y a aucune différence de comportement.

L'exemple de code suivant implémente un rappel onGoogleLibraryLoad:

<script>
  window.onGoogleLibraryLoad = () => {
   google.accounts.id.initialize({
     ...
   });
   google.accounts.id.prompt();
  };
</script>

Méthode: google.accounts.id.revoke

La méthode google.accounts.id.revoke révoque l'autorisation OAuth utilisée pour partager le jeton d'ID de l'utilisateur spécifié. Consultez l'extrait de code suivant de la méthode : javascript google.accounts.id.revoke(login_hint, callback)

L'exemple de code suivant montre comment utiliser la méthode revoke avec un ID.

  google.accounts.id.revoke('1618033988749895', done => {
    console.log(done.error);
  });

Type de données: RevocationResponse

Lorsque votre fonction callback est appelée, un objet RevocationResponse est transmis en tant que paramètre. Le tableau suivant répertorie les champs contenus dans l'objet de réponse de révocation:

réussi

Ce champ est une valeur booléenne définie sur "true" si l'appel de la méthode de révocation a réussi ou sur "false" en cas d'échec.

erreur

Ce champ est une valeur de chaîne et contient un message d'erreur détaillé si l'appel de méthode de révocation échoue ou qu'il n'est pas défini en cas de réussite.