Advertencia: Estos datos se proporcionan bajo la Política de datos de usuario de Google . Por favor revise y cumpla con la política. De lo contrario, podría resultar en la suspensión del proyecto o de la cuenta.

Referencia de la API de JavaScript con Acceso con Google

En esta página de referencia, se describe la API de JavaScript de acceso. Puedes usar esta API para mostrar el mensaje de One Tap o el botón Acceder con Google en tus páginas web.

Método: google.accounts.id.initialize

El método google.accounts.id.initialize inicializa el cliente de Acceder con Google según el objeto de configuración. Consulta el siguiente ejemplo de código del método:

google.accounts.id.initialize(IdConfiguration)

En el siguiente ejemplo de código, se implementa el método google.accounts.id.initialize con una función onload:

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

El método google.accounts.id.initialize crea una instancia de cliente de Acceder con Google que todos los módulos de la misma página web pueden usar de forma implícita.

  • Solo debes llamar al método google.accounts.id.initialize una vez, incluso si usas varios módulos (como One Tap, botón Personalizado, revocación, etc.) en la misma página web.
  • Si llamas al método google.accounts.id.initialize varias veces, solo se recordará y usará la configuración de la última llamada.

En realidad, restableces la configuración cada vez que llamas al método google.accounts.id.initialize, y todos los métodos posteriores en la misma página web usarán la configuración nueva de inmediato.

Tipo de datos: IdConfiguration

En la siguiente tabla, se enumeran los campos y las descripciones del tipo de datos IdConfiguration:

Campo
client_id El ID de cliente de tu aplicación
auto_select Habilita la selección automática.
callback La función de JavaScript que controla los tokens de ID. Google One Tap y el botón Acceder con Google popup Modo UX usan este atributo.
login_uri La URL de su extremo de acceso. El modo de UX redirect del botón Acceder con Google usa este atributo.
native_callback La función de JavaScript que controla las credenciales de las contraseñas.
cancel_on_tap_outside Cancela el mensaje si el usuario hace clic fuera del mensaje.
prompt_parent_id El ID de DOM del elemento del contenedor del mensaje de One Tap
nonce Una string aleatoria para tokens de ID
context El título y las palabras del mensaje de One Tap
state_cookie_domain Si necesitas llamar a One Tap en el dominio superior y sus subdominios, pasa el dominio superior a este campo para que se use una sola cookie compartida.
ux_mode El flujo de la UX del botón Acceder con Google
allowed_parent_origin Los orígenes que pueden incorporar el iframe intermedio. Si se presenta este campo, One Tap se ejecutará en el modo iframe intermedio.
intermediate_iframe_close_callback Anula el comportamiento predeterminado de iframe intermedio cuando los usuarios cierran One Tap de forma manual.
itp_support Habilita la UX mejorada de One Tap en navegadores ITP.

client_id

Este campo es el ID de cliente de tu aplicación, que se encuentra y crea en Google Developers Console. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string client_id: "CLIENT_ID.apps.googleusercontent.com"

selección automática

Este campo determina si un token de ID se muestra automáticamente sin interacción del usuario cuando solo hay una sesión de Google que aprobó tu app. El valor predeterminado es false. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
boolean Opcional auto_select: true

devolución de llamada

Este campo es la función de JavaScript que controla el token de ID que muestra el mensaje de One Tap o la ventana emergente. Este atributo es obligatorio si se usa el Modo de UX popup con Google One Tap o el botón Acceder con Google. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
función Obligatorio para One Tap y el modo de experiencia de usuario de popup callback: handleResponse

URI_de_acceso

Este atributo es el URI de su extremo de acceso. Se puede omitir si la página actual es tu página de acceso, en cuyo caso la credencial se publica en esta página de forma predeterminada.

La respuesta de la credencial del token de ID se publica en tu extremo de acceso cuando un usuario hace clic en el botón Acceder con Google y se usa el modo de UX de redireccionamiento.

Consulta la siguiente tabla para obtener más información:

Tipo Opcional Ejemplo
URL El valor predeterminado es el URI de la página actual o el valor que especifiques.
Solo se usa cuando se configura ux_mode: "redirect".
login_uri="https://www.example.com/login"

Tu extremo de acceso debe manejar las solicitudes POST que contienen una clave credential con un valor de token de ID en el cuerpo.

La siguiente es una solicitud de ejemplo para tu extremo de acceso:

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

credential=ID_TOKEN

devolución de llamada nativa

Este campo es el nombre de la función de JavaScript que controla la credencial de contraseña que muestra el administrador de credenciales nativo del navegador. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
función Opcional native_callback: handleResponse

cancelar_al_presionar_fuera

Este campo establece si se debe cancelar la solicitud de One Tap si un usuario hace clic fuera del mensaje. El valor predeterminado es true. Puedes inhabilitarlo si estableces el valor en false. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
boolean Opcional cancel_on_tap_outside: false

id_parent_id

Este atributo establece el ID del DOM del elemento contenedor. Si no está configurado, se muestra el mensaje de One Tap en la esquina superior derecha de la ventana. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional prompt_parent_id: 'parent_id'

nonce

Este campo es una string aleatoria que utiliza el token de ID para evitar ataques de repetición. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional nonce: "biaqbm70g23"

La longitud del nonce se limita al tamaño máximo de JWT compatible con tu entorno y a las restricciones de tamaño HTTP y del navegador individuales.

Contexto

Este campo cambia el texto del título y los mensajes en el mensaje de One Tap. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional context: "use"

En la siguiente tabla, se enumeran los contextos disponibles y sus descripciones:

Contexto
signin &Acceder con Google"
signup &Registrarse en Google"
use &Utilizar con Google"

Si necesitas mostrar One Tap en el dominio superior y sus subdominios, pasa el dominio superior a este campo para que se use una sola cookie de estado compartido. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional state_cookie_domain: "example.com"

modo-ux

Usa este campo para configurar el flujo de UX que usa el botón Acceder con Google. El valor predeterminado es popup. Este atributo no afecta la UX de OneTap. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional ux_mode: "redirect"

En la siguiente tabla, se enumeran los modos de UX disponibles y sus descripciones.

Modo de UX
popup Realiza el flujo de UX de acceso en una ventana emergente.
redirect Realiza el flujo de UX de acceso mediante el redireccionamiento de página completa.

origen_permitido

Los orígenes que pueden incorporar el iframe intermedio. One Tap se ejecutará en el modo iframe intermedio si aparece este campo. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string o arreglo de strings Opcional allowed_parent_origin: "https://example.com"

En la siguiente tabla, se enumeran los tipos de valores admitidos y sus descripciones.

Tipos de valor
string Un solo URI de dominio. &https://example.com"
string array Una matriz de URI de dominio. ["https://news.ejemplo.com" "https://local.example.com"]

También se admiten prefijos comodín. Por ejemplo, "https://*.example.com" coincidirá con example.com y sus subdominios en todos los niveles (p. ej., news.example.com, login.news.example.com). Ten en cuenta lo siguiente cuando uses comodines:

  • Las strings de patrón no pueden estar compuestas solo por un comodín y un dominio de nivel superior. Por ejemplo, https://*.com y https://*.co.uk no son válidos. Como se indicó anteriormente, "https://*.example.com" coincidirá con example.com y sus subdominios. También puedes usar un array para representar 2 dominios diferentes. Por ejemplo, ["https://example1.com", "https://*.example2.com"] coincidirá con los dominios example1.com, example2.com y subdominios de example2.com
  • Los dominios comodín deben comenzar con un esquema https:// seguro. "*.example.com" se considerará no válido.

Si el valor del campo allowed_parent_origin no es válido, la inicialización de One Tap del modo iframe intermedio fallará y se detendrá.

callback_intermedio_close_callback

Anula el comportamiento intermedio predeterminado de iframe cuando los usuarios cierran One Tap de forma manual presionando el botón 'X' en la IU de One Tap. El comportamiento predeterminado es quitar el iframe intermedio del DOM de inmediato.

El campo intermediate_iframe_close_callback solo se aplica en el modo intermedio de iframe. Y tiene impacto solo en el iframe intermedio, en lugar del iframe de One Tap. Se quita la IU de One Tap antes de invocar la devolución de llamada.

Tipo Obligatorio Ejemplo
función Opcional intermediate_iframe_close_callback: logBeforeClose

compatibilidad con itp

Este campo determina si se debe habilitar la UX actualizada de One Tap en los navegadores que admiten la Prevención de seguimiento inteligente (ITP). El valor predeterminado es false. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
boolean Opcional itp_support: true

Método: google.accounts.id.prompt

El método google.accounts.id.prompt muestra el mensaje de One Tap o el administrador de credenciales nativo del navegador después de que se invoca el método initialize(). Consulta el siguiente ejemplo de código del método:

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

Por lo general, se llama al método prompt() cuando se carga la página. Debido al estado de la sesión y a la configuración del usuario de Google, es posible que no se muestre la IU del mensaje de One Tap. Si quieres recibir notificaciones sobre el estado de la IU de diferentes momentos, pasa una función para recibir notificaciones sobre el estado de la IU.

Las notificaciones se activan en los siguientes momentos:

  • Momento de visualización:Esto ocurre después de que se llama al método prompt(). La notificación contiene un valor booleano para indicar si la IU se muestra o no.
  • Momento omitido: Se produce cuando el mensaje de One Tap se cierra mediante una cancelación automática o manual, o cuando Google no puede emitir una credencial, como cuando la sesión seleccionada salió de Google.

    En estos casos, te recomendamos que continúes con los siguientes proveedores de identidad, si los hubiera.

  • Momento descartado: Esto ocurre cuando Google recupera correctamente una credencial o un usuario desea detener el flujo de recuperación de credenciales. Por ejemplo, cuando el usuario comienza a ingresar su nombre de usuario y contraseña en tu diálogo de acceso, puedes llamar al método google.accounts.id.cancel() para cerrar el mensaje de One Tap y activar un momento descartado.

En el siguiente ejemplo de código, se implementa el momento que se omite:

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

Tipo de datos: PromptMomentNotification

En la siguiente tabla, se enumeran los métodos y las descripciones del tipo de datos PromptMomentNotification:

Método
isDisplayMoment() ¿Esta notificación aparece durante un momento?
isDisplayed() ¿Esta notificación se muestra durante un momento determinado y se muestra la IU?
isNotDisplayed() ¿Esta notificación aparece durante un momento determinado y no se muestra la IU?
getNotDisplayedReason()

El motivo detallado por el que no se muestra la IU. Los siguientes son los valores posibles:

  • browser_not_supported
  • invalid_client
  • missing_client_id
  • opt_out_or_no_session
  • secure_http_required
  • suppressed_by_user
  • unregistered_origin
  • unknown_reason
isSkippedMoment() ¿Esta notificación se omite por un momento?
getSkippedReason()

Es el motivo detallado del momento que se omitió. Los siguientes son los valores posibles:

  • auto_cancel
  • user_cancel
  • tap_outside
  • issuing_failed
isDismissedMoment() ¿Esta notificación se descarta?
getDismissedReason()

Es el motivo detallado del rechazo. Los siguientes son los valores posibles:

  • credential_returned
  • cancel_called
  • flow_restarted
getMomentType()

Muestra una string para el tipo de momento. Los siguientes son los valores posibles:

  • display
  • skipped
  • dismissed

Tipo de datos: CredentialResponse

Cuando se invoca la función callback, se pasa un objeto CredentialResponse como parámetro. En la siguiente tabla, se enumeran los campos que contiene el objeto de respuesta de la credencial:

Campo
credential Este campo es el token de ID que se muestra.
select_by Este campo establece cómo se selecciona la credencial.

credencial

Este campo es el token de ID como una string de token web JSON (JWT) codificada en base64.

Cuando se decodifica, el JWT se parece al siguiente ejemplo:

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

El campo sub contiene un identificador único global para la Cuenta de Google.

Con los campos email, email_verified y hd, puedes determinar si Google aloja una instancia de correo electrónico y si está autorizado o no para hacerlo. En los casos en que Google es autorizado, se sabe que el usuario es el propietario legítimo de la cuenta en este momento.

Casos en los que Google está autorizado:

  • email tiene un sufijo @gmail.com, que es una cuenta de Gmail.
  • Se estableció email_verified como verdadero y se estableció hd. Esta es una cuenta de G Suite.

Los usuarios pueden registrarse en Cuentas de Google sin usar Gmail ni G Suite. Cuando email no contiene un sufijo @gmail.com y hd está ausente, Google no tiene autoridad, por lo que se recomiendan otros métodos de verificación para verificar al usuario. email_verfied también puede ser verdadera, ya que Google verificó inicialmente el usuario cuando se creó la Cuenta de Google. Sin embargo, es posible que la propiedad de la cuenta de correo electrónico de terceros haya cambiado desde entonces.

select_by

En la siguiente tabla, se enumeran los valores posibles para el campo select_by. El tipo de botón que se usa junto con el estado de sesión y de consentimiento se usan para establecer el valor

  • El usuario presionó el botón One Tap o Acceder con Google, o usó el proceso de acceso automático sin contacto.

  • Se encontró una sesión existente, o el usuario seleccionó una Cuenta de Google y accedió a ella para establecer una nueva.

  • Antes de compartir las credenciales del token de ID con tu app, el usuario

    • presionar el botón Confirmar para otorgar su consentimiento a fin de compartir credenciales, o
    • ya había otorgado consentimiento y usó Seleccionar una cuenta para elegir una Cuenta de Google.

El valor de este campo se establece en uno de estos tipos:

Valor Descripción
auto Acceso automático de un usuario con una sesión existente que ya había otorgado consentimiento para compartir credenciales.
user Un usuario con una sesión existente que ya había otorgado consentimiento presionó el botón One Tap 'Continue as' para compartir las credenciales.
user_1tap Un usuario con una sesión existente presionó el botón Mantener presionado como para otorgar su consentimiento y compartir las credenciales. Solo se aplica a Chrome v75 y versiones posteriores.
user_2tap Un usuario que no tenía una sesión existente presionó el botón One 'Continue as' para seleccionar una cuenta y, luego, el botón Confirmar en una ventana emergente para otorgar su consentimiento y compartir las credenciales. Se aplica a navegadores que no están basados en Chromium.
btn Un usuario con una sesión existente que ya había otorgado consentimiento presionó el botón Acceder con Google y seleccionó una de Google para elegir las credenciales.
btn_confirm Un usuario con una sesión existente presionó el botón Acceder con Google y el botón Confirmar para otorgar su consentimiento y compartir las credenciales.
btn_add_session Un usuario sin sesión existente que ya había otorgado consentimiento presionó el botón Acceder con Google para seleccionar una Cuenta de Google y compartir las credenciales.
btn_confirm_add_session Un usuario sin una sesión existente primero presionó el botón Acceder con Google para seleccionar una Cuenta de Google y, luego, el botón Confirmar para aceptar y compartir las credenciales.

Método: google.accounts.id.renderButton

El método google.accounts.id.renderButton procesa un botón de Acceder con Google en tus páginas web.

Consulta el siguiente ejemplo de código del método:

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

Tipo de datos: GsiButtonConfiguration

En la siguiente tabla, se enumeran los campos y las descripciones del tipo de datos GsiButtonConfiguration:

Atributo
type El tipo de botón: ícono o botón estándar.
theme El tema del botón. Por ejemplo, lleno_azul o relleno_negro.
size El tamaño del botón. Por ejemplo, pequeño o grande.
text El texto del botón. Por ejemplo, "Acceder con Google" o "Registrarse con Google".
shape La forma del botón. Por ejemplo, rectangular o circular.
logo_alignment Alineación del logotipo de Google: izquierda o central.
width El ancho del botón, en píxeles.
locale Si se configura, se renderiza el idioma del botón.

Tipos de atributos

Las siguientes secciones contienen detalles sobre cada tipo de atributo y un ejemplo.

type

El tipo de botón. El valor predeterminado es standard.

Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string type: "icon"

En la siguiente tabla, se enumeran los tipos de botones disponibles y sus descripciones:

Tipo
standard Un botón con texto o información personalizada:
icon Un botón de ícono sin texto:

tema

El tema del botón. El valor predeterminado es outline. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional theme: "filled_blue"

En la siguiente tabla, se enumeran los temas disponibles y sus descripciones:

Tema
outline Un tema de botón estándar:
filled_blue Un tema de botón azul con relleno:
filled_black Un tema de botones negro:

size

El tamaño del botón. El valor predeterminado es large. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional size: "small"

En la siguiente tabla se indican los tamaños de botones disponibles y sus descripciones:

Tamaño
large Un botón grande:
Un botón estándar grande Un botón de ícono grande Un botón grande y personalizado
medium Un botón de tamaño mediano:
Un botón estándar mediano Un botón de ícono mediano
small Un botón pequeño:
Un botón pequeño Un pequeño ícono de botón

texto

El texto del botón. El valor predeterminado es signin_with. No hay diferencias visuales en el texto de los botones de ícono que tienen diferentes atributos text. La única excepción es cuando se lee el texto para mejorar la accesibilidad de la pantalla.

Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional text: "signup_with"

En la siguiente tabla, se enumeran los textos de botones disponibles y sus descripciones:

Texto
signin_with El texto del botón es "Acceder con Google":
signup_with El texto del botón es "Registrarse con Google":
continue_with El texto del botón es "Continuar con Google":
signin El texto del botón es "Acceder":

shape

La forma del botón. El valor predeterminado es rectangular. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional shape: "rectangular"

En la siguiente tabla, se enumeran las formas de botón disponibles y sus descripciones:

Forma
rectangular El botón de forma rectangular. Si se usa para el tipo de botón icon, es lo mismo que square.
pill El botón con forma de píldora. Si se usa para el tipo de botón icon, es lo mismo que circle.
circle El botón con forma de círculo. Si se usa para el tipo de botón standard, es lo mismo que pill.
square El botón con forma cuadrada Si se usa para el tipo de botón standard, es lo mismo que rectangular.

alineación_logotipo

Alineación del logotipo de Google El valor predeterminado es left. Este atributo solo se aplica al tipo de botón standard. Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional logo_alignment: "center"

En la siguiente tabla, se enumeran las alineaciones disponibles y sus descripciones:

alineación_logotipo
left Alinea a la izquierda el logotipo de Google.
center Alinea el centro con el logotipo de Google.

ancho

El ancho mínimo del botón, en píxeles. El ancho máximo es de 400 píxeles.

Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional width: 400

configuración regional

La configuración regional predeterminada del texto del botón. Si no está configurado, se usa la configuración regional predeterminada del navegador o la preferencia de usuario de la sesión de Google. Por lo tanto, los diferentes usuarios pueden ver distintas versiones de los botones localizados y, posiblemente, con diferentes tamaños.

Consulta la siguiente tabla para obtener más información:

Tipo Obligatorio Ejemplo
string Opcional locale: "zh_CN"

Tipo de datos: Credencial

Cuando se invoca la función native_callback, se pasa un objeto Credential como parámetro. En la siguiente tabla, se enumeran los campos contenidos en el objeto:

Campo
id Identifica al usuario.
password La contraseña

Método: google.accounts.id.disableAutoSelect

Cuando el usuario sale de tu sitio web, debes llamar al método google.accounts.id.disableAutoSelect para registrar el estado en cookies. Esto evita un bucle muerto de UX. Consulta el siguiente fragmento de código del método:

google.accounts.id.disableAutoSelect()

En el siguiente ejemplo de código, se implementa el método google.accounts.id.disableAutoSelect con una función onSignout():

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

Método: google.accounts.id.storeCredential

Este método es un wrapper sencillo para el método store() de la API de administrador de credenciales nativa del navegador. Por lo tanto, solo se puede usar para almacenar una credencial de contraseña. Consulta el siguiente ejemplo de código del método:

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

En el siguiente ejemplo de código, se implementa el método google.accounts.id.storeCredential con una función onSignIn():

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

Método: google.accounts.id.cancel

Puedes cancelar el flujo de One Tap si quitas el mensaje del DOM de la parte de confianza. La operación de cancelación se ignora si ya se seleccionó una credencial. Consulta el siguiente ejemplo de código del método:

google.accounts.id.cancel()

En el siguiente ejemplo de código, se implementa el método google.accounts.id.cancel() con una función onNextButtonClicked():

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

Devolución de llamada de carga de biblioteca: onGoogleLibraryLoad

Puedes registrar una devolución de llamada onGoogleLibraryLoad. Se notifica luego de que se carga la biblioteca JavaScript de Acceder con Google:

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

Esta devolución de llamada es solo un acceso directo para la devolución de llamada window.onload. No hay diferencias de comportamiento.

En el siguiente ejemplo de código, se implementa una devolución de llamada onGoogleLibraryLoad:

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

Método: google.accounts.id.revoke

El método google.accounts.id.revoke revoca el otorgamiento de OAuth que se usa para compartir el token de ID del usuario especificado. Consulta el siguiente fragmento de código del método: google.accounts.id.revoke(hint, callback)

Parámetro Tipo Descripción
hint string La dirección de correo electrónico o el ID único de la cuenta de Google del usuario El ID es la propiedad sub de la carga útil de la credencial.
callback función Controlador RevocationResponse opcional.

En la siguiente muestra de código, se indica cómo usar el método revoke con un ID.

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

Tipo de datos: RevocationResponse

Cuando se invoca la función callback, se pasa un objeto RevocationResponse como parámetro. En la siguiente tabla, se enumeran los campos que se encuentran en el objeto de respuesta de revocación:

Campo
successful Este campo es el valor de retorno de la llamada al método.
error De manera opcional, este campo contiene un mensaje de respuesta de error detallado.

exitoso

Este campo es un valor booleano configurado como verdadero si la llamada de método de revocación se realizó correctamente o como falsa en caso de error.

error

Este campo es un valor de string y contiene un mensaje de error detallado si la llamada de método de revocación falló, no está definido en caso de éxito.