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

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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

Para comenzar, obtén las credenciales del cliente de OAuth 2.0 en 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. Para ver una demostración interactiva del uso de OAuth 2.0 con Google (incluida la opción de usar 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 incluyen vínculos a contenido más detallado. Si deseas 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 se accede a una API de Google mediante OAuth 2.0. En un nivel alto, debes seguir estos 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 el ID y el secreto del cliente, que Google y tu aplicación conocen. El conjunto de valores varía según el tipo de aplicación que compiles. Por ejemplo, una aplicación de JavaScript no requiere un secreto, pero una aplicación de servidor web sí.

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

Antes de que tu aplicación pueda acceder a datos privados con una API de Google, debe obtener un token de acceso que le otorgue acceso a esa API. Un solo token de acceso puede otorgar diversos grados de acceso a varias API. 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.

Hay varias formas de realizar esta solicitud, que varían según el tipo de aplicación que compiles. Por ejemplo, una aplicación de JavaScript puede solicitar un token de acceso mediante el redireccionamiento a un navegador de Google, mientras que una aplicación instalada en un dispositivo que no tiene un navegador utiliza 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 tu aplicación está solicitando. Este proceso se denomina consentimiento de los usuarios.

Si el usuario otorga al menos un permiso, el servidor de autorización de Google envía a la aplicación un token de acceso (o un código de autorización que la 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 acceso, en lugar de hacerlo por adelantado. Por ejemplo, una app que quiere admitir que se guarde un evento en un calendario no debe solicitar acceso a Calendario de Google hasta que el usuario presione el botón "Agregar al Calendario". Consulta Autorización incremental.

3. Examina los permisos de acceso otorgados por el usuario.

Compara los permisos incluidos en la respuesta del token de acceso con los permisos necesarios para acceder a las funciones y funcionalidades de tu aplicación que dependen del acceso a una API de Google relacionada. Inhabilita cualquier función de tu app que no pueda 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 a fin de acceder. Una API puede asignar varios valores de string de permiso a un solo permiso de acceso y mostrar la misma string de permiso 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 a un usuario que autorice un alcance 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. Envía 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 mediante un encabezado de solicitud de autorización HTTP. Es posible enviar tokens como parámetros de string de consulta de URI, pero no recomendamos hacerlo, ya que los parámetros de URI pueden terminar en archivos de registro que no son completamente seguros. Además, se recomienda 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 la scope de la solicitud de token. Por ejemplo, si se emite un token de acceso para la API del Calendario de Google, no 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 duración limitada. Si tu aplicación necesita acceder a una API de Google más allá de la vida útil 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 Google OAuth 2.0 admite aplicaciones de servidor web que usan lenguajes y marcos de trabajo como PHP, Java, 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 búsqueda que indican el tipo de acceso que se solicita. Google se encarga de la autenticación, la selección de las sesiones 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 usarlo para acceder a una API de Google. Una vez que el token de acceso caduca, la aplicación usa 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, intercambia el código por un token y lo utiliza para llamar a un extremo de la API de Google.

Si deseas obtener más detalles, consulta Usa OAuth 2.0 para aplicaciones de servidor web.

Aplicaciones instaladas

El extremo de Google OAuth 2.0 admite aplicaciones que se instalan 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, la app de Chrome, iOS, la plataforma universal de Windows (UWP) o la app de escritorio como el tipo de aplicación.

El proceso da como resultado 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 obviamente 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 búsqueda que indican el tipo de acceso que se solicita. Google se encarga de la autenticación, la selección de las sesiones 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 usarlo para acceder a una API de Google. Una vez que el token de acceso caduca, la aplicación usa 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, intercambia el código por un token y lo utiliza para llamar a un extremo de la API de Google.

Para obtener detalles, consulta Usa OAuth 2.0 para aplicaciones instaladas.

Aplicaciones del cliente (JavaScript)

El extremo de Google OAuth 2.0 admite las aplicaciones 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 búsqueda que indican el tipo de acceso que se solicita. Google se encarga de la autenticación, la selección de las sesiones 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 el token caduca, 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 detalles, consulta Usa 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 limitada, como consolas de juegos, impresoras y cámaras de video.

La secuencia de autorización comienza cuando la aplicación realiza una solicitud de servicio web a una URL de Google para un código de autorización. La respuesta contiene varios parámetros, incluidos 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 computadora con capacidades de entrada 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. Una vez 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 usarlo para acceder a una API de Google. Una vez que el token de acceso caduca, la aplicación usa el token de actualización para obtener uno nuevo.

El usuario accede en un dispositivo separado que tiene un navegador

Para obtener más información, consulta Usa OAuth 2.0 para dispositivos.

Cuentas de servicio

Las API de Google, como Prediction API 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 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 en lugar de a un usuario final individual. Tu aplicación llama a las API de Google en nombre de la cuenta de servicio y no se requiere el consentimiento del usuario. (En casos ajenos a la cuenta de servicios, tu aplicación llama a las API 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 clave pública/privada. Usa 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, la aplicación envía la solicitud de token al servidor de autorización de Google OAuth 2.0, que muestra un token de acceso. La aplicación usa el token para acceder a una API de Google. Cuando el token vence, la aplicación repite el proceso.

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

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

Tamaño del token

El tamaño de los tokens puede variar hasta en 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 del servicio de token de seguridad de Google Cloud se estructuran de manera similar a los tokens de acceso de OAuth 2.0 de la API de Google, pero tienen límites de tamaño de token diferentes. Para obtener más detalles, 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 prever la posibilidad de que un token de actualización otorgado deje de funcionar. Un token de actualización puede dejar de funcionar por uno de estos motivos:

  • El usuario revocó el acceso de tu app.
  • No se usó el token de actualización durante seis meses.
  • El usuario cambió las contraseñas y el token de actualización contiene permisos de Gmail.
  • La cuenta de usuario excedió la cantidad máxima de tokens de actualización otorgados (activos).
  • El usuario pertenece a una organización de Google Cloud Platform que tiene políticas de control de sesiones vigentes.

Un proyecto de Google Cloud Platform con una pantalla de consentimiento de OAuth configurada para un tipo de usuario externo y el estado de publicación “Prueba” se emite un token de actualización que vence en 7 días.

Actualmente, existe un límite de 100 tokens de actualización por Cuenta de Google por cada ID de cliente de OAuth 2.0. Si se alcanza el límite, la creación de un nuevo token de actualización 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 existe un límite mayor para la cantidad total de tokens de actualización que una cuenta de usuario o de servicio puede tener en todos los clientes. La mayoría de los usuarios normales no superarán este límite, pero la cuenta de un desarrollador que se use para probar una implementación podría hacerlo.

Si necesitas autorizar varios programas, máquinas o dispositivos, una solución puede ser 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.

Trabajar con políticas de control de sesiones para organizaciones de Google Cloud Platform (GCP)

Los administradores de las organizaciones de GCP pueden requerir una reautenticación frecuente de los usuarios mientras acceden a los recursos de GCP mediante la función de control de sesiones de Google Cloud. Esta política afecta el acceso a Google Cloud Console, el SDK de Google Cloud (también conocido como la CLI de gcloud) y cualquier aplicación de OAuth de terceros que requiera el permiso de Cloud Platform. Si un usuario tiene implementada una política de control de sesión, cuando venza la duración de la sesión, las llamadas a la API fallarán de manera similar a lo que sucedería si se revocara el token de actualización. La llamada fallará con un tipo de error invalid_token. Se puede usar el tipo de suberror para distinguir entre un token de revocación y un error debido a una política de control de sesión. Dado que las duraciones de las sesiones pueden ser muy limitadas (entre 1 hora y 24 horas), esta situación se debe manejar correctamente; para ello, reinicia una sesión de autenticación.

Del mismo modo, no debes usar ni alentar el uso de credenciales de usuario para la implementación de servidor a servidor. Si se implementan las credenciales de usuario en un servidor para operaciones o trabajos 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á manera de volver a autenticarlo cuando venza la duración de la sesión.

Para obtener más información sobre cómo ayudar a tus clientes a implementar esta función, consulta este artículo de ayuda centrado en el administrador.

Bibliotecas cliente

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