Cómo usar OAuth 2.0 para acceder a las API de Google

Las APIs de Google usan el Protocolo OAuth 2.0 para la autenticación y la autorización. Google admite situaciones comunes de OAuth 2.0, como las de aplicaciones de servidor web, cliente, instaladas y de dispositivos de entrada limitada.

Para comenzar, obtén credenciales de cliente de OAuth 2.0 de Google API Console. Luego, tu aplicación cliente solicita un token de acceso al servidor de autorización de Google, extrae un token de la respuesta y lo envía a la API de Google a la que deseas acceder. Si deseas ver una demostración interactiva de cómo utilizar OAuth 2.0 con Google (incluye la opción de utilizar tus propias credenciales de cliente), experimenta con OAuth 2.0 Playground.

En esta página, se proporciona una descripción general de las situaciones de autorización de OAuth 2.0 que admite Google y se proporcionan vínculos a contenido más detallado. Para obtener detalles sobre el uso de OAuth 2.0 para la autenticación, consulta OpenID Connect.

Pasos básicos

Todas las aplicaciones siguen un patrón básico cuando acceden a una API de Google con OAuth 2.0. En un nivel superior, sigues cinco pasos:

1. Obtén credenciales de OAuth 2.0 de Google API Console.

Visita Google API Console para obtener credenciales de OAuth 2.0, como un ID de cliente y un secreto de cliente que Google y tu aplicación conozcan. El conjunto de valores varía según el tipo de aplicación que compilas. Por ejemplo, una aplicación de JavaScript no requiere un secreto, pero una aplicación de servidor web sí.

Debes crear un cliente de OAuth adecuado para la plataforma en la que se ejecutará tu app, por ejemplo:

2. Obtén un token de acceso del servidor de autorización de Google.

Para que tu aplicación pueda acceder a datos privados con una API de Google, debe obtener un token de acceso que otorgue acceso a esa API. Un solo token de acceso puede otorgar diferentes grados de acceso a varias APIs. Un parámetro variable llamado scope controla el conjunto de recursos y operaciones que permite un token de acceso. Durante la solicitud de token de acceso, tu aplicación envía uno o más valores en el parámetro scope.

Existen varias formas de realizar esta solicitud, que varían según el tipo de aplicación que compilas. Por ejemplo, una aplicación de JavaScript podría solicitar un token de acceso con un redireccionamiento del navegador a Google, mientras que una aplicación instalada en un dispositivo que no tiene navegador usa solicitudes de servicio web.

Algunas solicitudes requieren un paso de autenticación en el que el usuario accede con su cuenta de Google. Después de acceder, se le pregunta al usuario si está dispuesto a otorgar uno o más permisos que solicita tu aplicación. Este proceso se denomina consentimiento del usuario.

Si el usuario otorga al menos un permiso, el servidor de autorización de Google envía a tu aplicación un token de acceso (o un código de autorización que tu aplicación puede usar para obtener un token de acceso) y una lista de alcances de acceso otorgados por ese token. Si el usuario no otorga el permiso, el servidor muestra un error.

Por lo general, se recomienda solicitar permisos de forma incremental, en el momento en que se requiere el acceso, en lugar de hacerlo de antemano. Por ejemplo, una app que quiera admitir el guardado de un evento en un calendario no debe solicitar acceso al Calendario de Google hasta que el usuario presione el botón "Agregar al Calendario". Consulta Autorización incremental.

3. Examinar los permisos de acceso que otorgó el usuario

Compara los permisos incluidos en la respuesta del token de acceso con los permisos necesarios para acceder a las funciones de tu aplicación que dependen del acceso a una API de Google relacionada. Inhabilita las funciones de tu app que no puedan funcionar sin acceso a la API relacionada.

Es posible que el permiso incluido en tu solicitud no coincida con el permiso incluido en tu respuesta, incluso si el usuario otorgó todos los permisos solicitados. Consulta la documentación de cada API de Google para conocer los permisos necesarios para el acceso. Una API puede asignar varios valores de cadena de alcance a un solo alcance de acceso y mostrar la misma cadena de alcance para todos los valores permitidos en la solicitud. Ejemplo: La API de Google People puede mostrar un permiso de https://www.googleapis.com/auth/contacts cuando una app solicita que un usuario autorice un permiso de https://www.google.com/m8/feeds/. El método people.updateContact de la API de Google People requiere un permiso otorgado de https://www.googleapis.com/auth/contacts.

4. Enviar el token de acceso a una API

Después de que una aplicación obtiene un token de acceso, lo envía a una API de Google en un encabezado de solicitud de autorización HTTP. Es posible enviar tokens como parámetros de cadena de consulta de URI, pero no lo recomendamos, ya que los parámetros de URI pueden terminar en archivos de registro que no son completamente seguros. Además, es una buena práctica de REST evitar crear nombres de parámetros de URI innecesarios.

Los tokens de acceso solo son válidos para el conjunto de operaciones y recursos descritos en el scope de la solicitud de token. Por ejemplo, si se emite un token de acceso para la API de Google Calendar, no se otorga acceso a la API de Contactos de Google. Sin embargo, puedes enviar ese token de acceso a la API de Calendario de Google varias veces para operaciones similares.

5. Actualiza el token de acceso si es necesario.

Los tokens de acceso tienen una vida útil limitada. Si tu aplicación necesita acceso a una API de Google más allá del ciclo de vida de un solo token de acceso, puede obtener un token de actualización. Un token de actualización permite que tu aplicación obtenga nuevos tokens de acceso.

Situaciones

Aplicaciones de servidor web

El extremo de OAuth 2.0 de Google admite aplicaciones de servidor web que usan lenguajes y frameworks como PHP, Java, Go, Python, Ruby y ASP.NET.

La secuencia de autorización comienza cuando tu aplicación redirecciona un navegador a una URL de Google. La URL incluye parámetros de consulta que indican el tipo de acceso que se solicita. Google controla la autenticación del usuario, la selección de la sesión y el consentimiento del usuario. El resultado es un código de autorización, que la aplicación puede intercambiar por un token de acceso y un token de actualización.

La aplicación debe almacenar el token de actualización para usarlo en el futuro y usar el token de acceso para acceder a una API de Google. Una vez que venza el token de acceso, la aplicación usará el token de actualización para obtener uno nuevo.

Tu aplicación envía una solicitud de token al servidor de autorización de Google, recibe un código de autorización, lo intercambia por un token y lo usa para llamar a un extremo de la API de Google.

Si deseas obtener más información, consulta Cómo usar OAuth 2.0 para aplicaciones de servidor web.

Aplicaciones instaladas

El extremo de Google OAuth 2.0 admite aplicaciones instaladas en dispositivos como computadoras, dispositivos móviles y tablets. Cuando crees un ID de cliente a través de Google API Console, especifica que se trata de una aplicación instalada y, luego, selecciona Android, app para Chrome, iOS, Universal Windows Platform (UWP) o app para computadoras de escritorio como el tipo de aplicación.

El proceso genera un ID de cliente y, en algunos casos, un secreto de cliente, que incorporas en el código fuente de tu aplicación. (En este contexto, el secreto del cliente, por supuesto, no se trata como un secreto).

La secuencia de autorización comienza cuando tu aplicación redirecciona un navegador a una URL de Google. La URL incluye parámetros de consulta que indican el tipo de acceso que se solicita. Google controla la autenticación del usuario, la selección de la sesión y el consentimiento del usuario. El resultado es un código de autorización, que la aplicación puede intercambiar por un token de acceso y un token de actualización.

La aplicación debe almacenar el token de actualización para usarlo en el futuro y usar el token de acceso para acceder a una API de Google. Una vez que venza el token de acceso, la aplicación usará el token de actualización para obtener uno nuevo.

Tu aplicación envía una solicitud de token al servidor de autorización de Google, recibe un código de autorización, lo intercambia por un token y lo usa para llamar a un extremo de la API de Google.

Si deseas obtener más información, consulta Usa OAuth 2.0 para aplicaciones instaladas.

Aplicaciones del cliente (JavaScript)

El extremo de Google OAuth 2.0 admite aplicaciones de JavaScript que se ejecutan en un navegador.

La secuencia de autorización comienza cuando tu aplicación redirecciona un navegador a una URL de Google. La URL incluye parámetros de consulta que indican el tipo de acceso que se solicita. Google controla la autenticación del usuario, la selección de la sesión y el consentimiento del usuario.

El resultado es un token de acceso, que el cliente debe validar antes de incluirlo en una solicitud a la API de Google. Cuando vence el token, la aplicación repite el proceso.

Tu aplicación de JS envía una solicitud de token al servidor de autorización de Google, recibe un token, lo valida y lo usa para llamar a un extremo de la API de Google.

Si deseas obtener más información, consulta Cómo usar OAuth 2.0 para aplicaciones del cliente.

Aplicaciones en dispositivos de entrada limitada

El extremo de Google OAuth 2.0 admite aplicaciones que se ejecutan en dispositivos de entrada limitados, como consolas de juegos, cámaras de video y, también, impresoras.

La secuencia de autorización comienza con la aplicación que realiza una solicitud de servicio web a una URL de Google para obtener un código de autorización. La respuesta contiene varios parámetros, incluida una URL y un código que la aplicación muestra al usuario.

El usuario obtiene la URL y el código del dispositivo y, luego, cambia a otro dispositivo o a una computadora con capacidades de entrada más enriquecidas. El usuario inicia un navegador, navega a la URL especificada, accede y, luego, ingresa el código.

Mientras tanto, la aplicación sondea una URL de Google en un intervalo especificado. Después de que el usuario aprueba el acceso, la respuesta del servidor de Google contiene un token de acceso y un token de actualización. La aplicación debe almacenar el token de actualización para usarlo en el futuro y usar el token de acceso para acceder a una API de Google. Una vez que venza el token de acceso, la aplicación usará el token de actualización para obtener uno nuevo.

El usuario accede en un dispositivo diferente que tiene un navegador

Para obtener más información, consulta Cómo usar OAuth 2.0 para dispositivos.

Cuentas de servicio

Las APIs de Google, como la API de Prediction y Google Cloud Storage, pueden actuar en nombre de tu aplicación sin acceder a la información del usuario. En estas situaciones, tu aplicación debe demostrar su propia identidad a la API, pero no se necesita el consentimiento del usuario. Del mismo modo, en situaciones empresariales, tu aplicación puede solicitar acceso delegado a algunos recursos.

Para estos tipos de interacciones de servidor a servidor, necesitas una cuenta de servicio, que es una cuenta que pertenece a tu aplicación, no a un usuario final individual. Tu aplicación llama a las APIs de Google en nombre de la cuenta de servicio, y no se requiere el consentimiento del usuario. (En casos que no son de cuenta de servicio, tu aplicación llama a las APIs de Google en nombre de los usuarios finales y, a veces, se requiere el consentimiento del usuario).

Las credenciales de una cuenta de servicio, que obtienes de Google API Console, incluyen una dirección de correo electrónico generada que es única, un ID de cliente y, al menos, un par de claves públicas/privadas. Usas el ID de cliente y una clave privada para crear un JWT firmado y crear una solicitud de token de acceso en el formato adecuado. Luego, tu aplicación envía la solicitud de token al servidor de autorización de OAuth 2.0 de Google, que muestra un token de acceso. La aplicación usa el token para acceder a una API de Google. Cuando el token venza, la aplicación repetirá el proceso.

Tu aplicación de servidor usa un JWT para solicitar un token al servidor de autorización de Google y, luego, usa el token para llamar a un extremo de la API de Google. No hay ningún usuario final involucrado.

Para obtener más información, consulta la documentación de la cuenta de servicio.

Tamaño del token

El tamaño de los tokens puede variar hasta los siguientes límites:

  • Códigos de autorización: 256 bytes
  • Tokens de acceso: 2,048 bytes
  • Tokens de actualización: 512 bytes

Los tokens de acceso que muestra la API de Security Token Service de Google Cloud están estructurados de manera similar a los tokens de acceso de OAuth 2.0 de la API de Google, pero tienen diferentes límites de tamaño de token. Para obtener más información, consulta la documentación de la API.

Google se reserva el derecho de cambiar el tamaño del token dentro de estos límites, y tu aplicación debe admitir tamaños de token variables según corresponda.

Actualiza el vencimiento del token

Debes escribir tu código para anticipar la posibilidad de que un token de actualización otorgado ya no funcione. Es posible que un token de actualización deje de funcionar por uno de los siguientes motivos:

A un proyecto de Google Cloud Platform con una pantalla de consentimiento de OAuth configurada para un tipo de usuario externo y un estado de publicación de “Pruebas” se le emite un token de actualización que vence en 7 días, a menos que los únicos permisos de OAuth solicitados sean un subconjunto de nombre, dirección de correo electrónico y perfil de usuario (a través de los permisos userinfo.email, userinfo.profile, openid o sus equivalentes de OpenID Connect).

Actualmente, existe un límite de 100 tokens de actualización por Cuenta de Google por ID de cliente de OAuth 2.0. Si se alcanza el límite, la creación de un token de actualización nuevo invalida automáticamente el token de actualización más antiguo sin advertencia. Este límite no se aplica a las cuentas de servicio.

También hay un límite mayor para la cantidad total de tokens de actualización que puede tener una cuenta de usuario o de servicio en todos los clientes. La mayoría de los usuarios normales no superarán este límite, pero es posible que lo haga la cuenta de un desarrollador que se use para probar una implementación.

Si necesitas autorizar varios programas, máquinas o dispositivos, una solución alternativa es limitar a 15 o 20 la cantidad de clientes que autorizas por Cuenta de Google. Si eres un administrador de Google Workspace, puedes crear usuarios adicionales con privilegios administrativos y usarlos para autorizar a algunos de los clientes.

Cómo lidiar con las políticas de control de sesión para organizaciones de Google Cloud Platform (GCP)

Los administradores de organizaciones de GCP pueden requerir que los usuarios se vuelvan a autenticar con frecuencia mientras acceden a los recursos de GCP con la función de control de sesiones de Google Cloud. Esta política afecta el acceso a la consola de Google Cloud, al SDK de Google Cloud (también conocido como la CLI de gcloud) y a cualquier aplicación de OAuth de terceros que requiera el permiso de Cloud Platform. Si un usuario tiene una política de control de sesión implementada, cuando venza la duración de la sesión, tus llamadas a la API mostrarán un error similar al que ocurriría si se revocara el token de actualización: la llamada fallará con un tipo de error invalid_grant. El campo error_subtype se puede usar para distinguir entre un token revocado y una falla debido a una política de control de sesión (por ejemplo, "error_subtype": "invalid_rapt"). Como las duraciones de las sesiones pueden ser muy limitadas (entre 1 hora y 24 horas), esta situación se debe controlar de forma fluida reiniciando una sesión de autenticación.

Del mismo modo, no debes usar ni fomentar el uso de credenciales de usuario para la implementación de servidor a servidor. Si las credenciales del usuario se implementan en un servidor para trabajos o operaciones de larga duración y un cliente aplica políticas de control de sesión en esos usuarios, la aplicación del servidor fallará, ya que no habrá forma de volver a autenticar al usuario cuando venza la duración de la sesión.

Si quieres obtener más información para ayudar a tus clientes a implementar esta función, consulta este artículo de ayuda enfocado en los administradores.

Bibliotecas cliente

Las siguientes bibliotecas cliente se integran en frameworks populares, lo que simplifica la implementación de OAuth 2.0. Con el tiempo, se agregarán más funciones a las bibliotecas.