Se usó la API de Cloud Translation para traducir esta página.

Vinculación de Cuentas de Google con OAuth

Las cuentas se vinculan mediante los flujos implícitos y de código de autorización de OAuth 2.0 estándar de la industria. Tu servicio debe ser compatible con los extremos de autorización y intercambio de tokens que cumplan con OAuth 2.0.

En el flujo implícito, Google abre el extremo de autorización en el navegador del usuario. Después de que el acceso sea exitoso, se muestra un token de acceso de larga duración a Google. Este token de acceso ahora se incluye en cada solicitud enviada desde Google.

En el flujo de código de autorización, necesitas dos extremos:

El extremo de autorización, que presenta la IU de acceso a los usuarios que aún no accedieron. El extremo de autorización también crea un código de autorización de corta duración para registrar el acceso solicitado por los usuarios.
El extremo de intercambio de tokens, que es responsable de dos tipos de intercambios:
1. Intercambia un código de autorización por un token de actualización de larga duración y un token de acceso de corta duración. Este intercambio se produce cuando el usuario pasa por el flujo de vinculación de cuentas.
2. Intercambia un token de actualización de larga duración por un token de acceso de corta duración. Este intercambio se produce cuando Google necesita un nuevo token de acceso porque venció.

Elige un flujo de OAuth 2.0

Aunque el flujo implícito es más fácil de implementar, Google recomienda que los tokens de acceso emitidos por el flujo implícito nunca venzan. Esto se debe a que el usuario se ve obligado a vincular su cuenta de nuevo después de que un token caduque con el flujo implícito. Si necesitas el vencimiento del token por razones de seguridad, te recomendamos que uses el flujo de código de autorización en su lugar.

Pautas de diseño

En esta sección, se describen los requisitos de diseño y las recomendaciones para la pantalla del usuario que alojas en los flujos de vinculación de OAuth. Una vez que la app la llama, tu plataforma le muestra al usuario un acceso a la página de Google y a la pantalla de consentimiento de vinculación de la cuenta. Cuando el usuario da su consentimiento para vincular las cuentas, se lo redirige a la app de Google.

En esta figura, se muestran los pasos para que un usuario vincule su Cuenta de Google a tu sistema de autenticación. La primera captura de pantalla muestra vínculos iniciados por el usuario desde tu plataforma. En la segunda, se muestra el acceso del usuario a Google, mientras que la tercera muestra el consentimiento y la confirmación para vincular su Cuenta de Google con tu app. En la última captura de pantalla, se muestra una cuenta de usuario vinculada correctamente en Google app. — **Figura 1:** Cuenta de vinculación de usuarios que accede a Google y a las pantallas de consentimiento.

Requisitos

Debes comunicar que la cuenta del usuario se vinculará a Google, no a un producto de Google específico, como Google Home o el Asistente de Google.

Recomendaciones

Create the project

To create your project to use account linking:

Go to the Google API Console.
Haz clic en Crear proyecto .
Ingrese un nombre o acepte la sugerencia generada.
Confirme o edite los campos restantes.
Haz clic en Crear .

Para ver su ID de proyecto:

Go to the Google API Console.
Encuentra tu proyecto en la tabla de la página de inicio. El ID del proyecto aparece en la columna ID .

Configure your OAuth Consent Screen

The Google Account Linking process includes a consent screen which tells users the application requesting access to their data, what kind of data they are asking for and the terms that apply. You will need to configure your OAuth consent screen before generating a Google API client ID.

Open the OAuth consent screen page of the Google APIs console.
If prompted, select the project you just created.
On the "OAuth consent screen" page, fill out the form and click the “Save” button.

Application name: The name of the application asking for consent. The name should accurately reflect your application and be consistent with the application name users see elsewhere. The application name will be shown on the Account Linking consent screen.

Application logo: An image on the consent screen that will help users recognize your app. The logo is shown on Account linking consent screen and on account settings

Support email: For users to contact you with questions about their consent.

Scopes for Google APIs: Scopes allow your application to access your user's private Google data. For the Google Account Linking use case, default scope (email, profile, openid) is sufficient, you don’t need to add any sensitive scopes. It is generally a best practice to request scopes incrementally, at the time access is required, rather than up front. Learn more.

Authorized domains: To protect you and your users, Google only allows applications that authenticate using OAuth to use Authorized Domains. Your applications' links must be hosted on Authorized Domains. Learn more.

Application Homepage link: Home page for your application. Must be hosted on an Authorized Domain.

Application Privacy Policy link: Shown on Google Acount Linking consent screen. Must be hosted on an Authorized Domain.

Application Terms of Service link (Optional): Must be hosted on an Authorized Domain.

Figure 1. Google Account Linking Consent Screen for a fictitious Application, Tunery
Check "Verification Status", if your application needs verification then click the "Submit For Verification" button to submit your application for verification. Refer to OAuth verification requirements for details.

Implementa tu servidor OAuth

Un servidor de aplicación de OAuth 2.0 del flujo de código de autorización consiste en dos puntos finales, que su servicio pone a disposición mediante HTTPS. El primer punto final es el punto final de autorización, que es responsable de encontrar u obtener el consentimiento de los usuarios para el acceso a los datos. El extremo de autorización presenta una IU de inicio de sesión para los usuarios que aún no han iniciado sesión y registra el consentimiento para el acceso solicitado. El segundo punto final es el punto final de intercambio de tokens, que se utiliza para obtener cadenas cifradas, llamadas tokens, que autorizan a un usuario a acceder a su servicio.

Cuando una aplicación de Google necesita llamar a una de las API de su servicio, Google usa estos puntos finales juntos para obtener el permiso de sus usuarios para llamar a estas API en su nombre.

Una sesión de flujo de código de autorización de OAuth 2.0 iniciada por Google tiene el siguiente flujo:

Google abre su punto final de autorización en el navegador del usuario. Si el flujo comenzó en un dispositivo solo de voz para una acción, Google transfiere la ejecución a un teléfono.
El usuario inicia sesión, si aún no lo ha hecho, y le otorga permiso a Google para acceder a sus datos con su API, si aún no lo ha otorgado.
Su servicio crea un código de autorización y lo devuelve a Google. Para hacerlo, redirija el navegador del usuario a Google con el código de autorización adjunto a la solicitud.
Google envía el código de autorización a su punto final el intercambio de token, que verifica la autenticidad del código y devuelve un token y un token de acceso de actualización. El token de acceso es un token de corta duración que su servicio acepta como credenciales para acceder a las API. El token de actualización es un token de larga duración que Google puede almacenar y usar para adquirir nuevos tokens de acceso cuando vencen.
Una vez que el usuario ha completado el flujo de vinculación de la cuenta, cada solicitud posterior enviada desde Google contiene un token de acceso.

Manejar solicitudes de autorización

Cuando necesita realizar la vinculación de cuentas mediante el flujo de código de autorización de OAuth 2.0, Google envía al usuario a su punto final de autorización con una solicitud que incluye los siguientes parámetros:

Parámetros de punto final de autorización
`client_id`	El ID de cliente que asignó a Google.
`redirect_uri`	La URL a la que envía la respuesta a esta solicitud.
`state`	Un valor contable que se devuelve a Google sin cambios en el URI de redireccionamiento.
`scope`	Opcional: Un conjunto delimitada por espacios de las cadenas de alcance que especifican los datos de Google está solicitando autorización para.
`response_type`	El tipo de valor que se devolverá en la respuesta. Para el OAuth flujo de código de autorización 2.0, el tipo de respuesta es siempre `code` .
`user_locale`	La configuración de idioma en la cuenta de Google RFC5646 formato, que se utiliza para localizar el contenido en el idioma preferido del usuario.

Por ejemplo, si su punto final de autorización está disponible en https://myservice.example.com/auth , una solicitud puede tener un aspecto como el siguiente:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

Para que su punto final de autorización maneje las solicitudes de inicio de sesión, siga los siguientes pasos:

Compruebe que la client_id coincide con el ID de cliente que ha asignado a Google, y que el redirect_uri coincide con la URL de redireccionamiento proporcionado por Google para su servicio. Estas comprobaciones son importantes para evitar otorgar acceso a aplicaciones cliente no intencionadas o mal configuradas. Si admite múltiples flujos de OAuth 2.0, también confirmar que el response_type es code .
Compruebe si el usuario ha iniciado sesión en su servicio. Si el usuario no ha iniciado sesión, complete el proceso de inicio de sesión o registro de su servicio.
Genere un código de autorización para que Google lo utilice para acceder a su API. El código de autorización puede ser cualquier valor de cadena, pero debe representar de forma única al usuario, el cliente para el que es el token y la hora de vencimiento del código, y no debe ser adivinable. Por lo general, emite códigos de autorización que caducan después de aproximadamente 10 minutos.

Confirmar que la URL especificada por el redirect_uri parámetro tiene la siguiente forma:

  https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
  https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID

Redirigir el navegador del usuario a la URL especificada por el redirect_uri parámetro. Incluir el código de autorización que acaba de generar y el original, el valor de estado no modificado cuando se redirige al anexar los code y state parámetros. El siguiente es un ejemplo de la URL resultante:
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING
```

Manejar solicitudes de intercambio de tokens

El punto final de intercambio de tokens de su servicio es responsable de dos tipos de intercambios de tokens:

Intercambiar códigos de autorización para tokens de acceso y tokens de actualización
Intercambiar tokens de actualización por tokens de acceso

Las solicitudes de intercambio de tokens incluyen los siguientes parámetros:

Parámetros de punto final de intercambio de tokens
`client_id`	Una cadena que identifica el origen de la solicitud como Google. Esta cadena debe estar registrada en su sistema como identificador único de Google.
`client_secret`	Una cadena secreta que registró en Google para su servicio.
`grant_type`	El tipo de token que se intercambia. Es bien `authorization_code` o `refresh_token` .
`code`	Cuando `grant_type=authorization_code` , este parámetro es el código de Google recibido ya sea de su inicio de sesión o criterio de valoración de intercambio simbólico.
`redirect_uri`	Cuando `grant_type=authorization_code` , este parámetro es el URL que se utiliza en la solicitud de autorización inicial.
`refresh_token`	Cuando `grant_type=refresh_token` , este parámetro es el token de actualización de Google ha recibido desde su punto final el intercambio simbólico.

Intercambiar códigos de autorización para tokens de acceso y tokens de actualización

Una vez que el usuario inicia sesión y su punto final de autorización devuelve un código de autorización de corta duración a Google, Google envía una solicitud a su punto final de intercambio de tokens para intercambiar el código de autorización por un token de acceso y un token de actualización.

Para estas solicitudes, el valor de grant_type es authorization_code , y el valor de code es el valor del código de autorización previamente concedida a Google. El siguiente es un ejemplo de una solicitud para intercambiar un código de autorización por un token de acceso y un token de actualización:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

Para intercambiar códigos de autorización para un token de acceso y una actualización manera, el token de cambio de punto final responde a POST peticiones de ejecución de los siguientes pasos:

Verificar que los client_id identifica el origen petición como un origen autorizado, y que el client_secret coincide con el valor esperado.
Verifique que el código de autorización sea válido y no esté vencido, y que el ID de cliente especificado en la solicitud coincida con el ID de cliente asociado con el código de autorización.
Confirmar que la URL especificada por el redirect_uri parámetro es idéntico al valor utilizado en la solicitud de autorización inicial.
Si no se puede verificar todos los criterios anteriores, devolverá un error HTTP 400 Bad Request con {"error": "invalid_grant"} como el cuerpo.
De lo contrario, utilice el ID de usuario del código de autorización para generar un token de actualización y un token de acceso. Estos tokens pueden ser cualquier valor de cadena, pero deben representar de forma única al usuario y al cliente para el que es el token, y no deben ser adivinables. En el caso de los tokens de acceso, también registre el tiempo de vencimiento del token, que suele ser una hora después de emitir el token. Los tokens de actualización no caducan.

Devolver el siguiente objeto JSON en el cuerpo de la respuesta HTTPS:

{
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"refresh_token": "REFRESH_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

Google almacena el token de acceso y el token de actualización para el usuario y registra la expiración del token de acceso. Cuando el token de acceso caduca, Google usa el token de actualización para obtener un nuevo token de acceso desde su punto final de intercambio de tokens.

Intercambiar tokens de actualización por tokens de acceso

Cuando un token de acceso caduca, Google envía una solicitud a su punto final de intercambio de tokens para intercambiar un token de actualización por un nuevo token de acceso.

Para estas solicitudes, el valor de grant_type se refresh_token , y el valor de refresh_token es el valor de la señal de actualización previamente otorgados a Google. El siguiente es un ejemplo de una solicitud para intercambiar un token de actualización por un token de acceso:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

Intercambiar una actualización token para un token de acceso, el token de cambio de punto final responde a POST peticiones de ejecución de los siguientes pasos:

Verificar que los client_id identifica el origen petición como Google, y que el client_secret coincide con el valor esperado.
Verifique que el token de actualización sea válido y que el ID de cliente especificado en la solicitud coincida con el ID de cliente asociado con el token de actualización.
Si no se puede verificar todos los criterios anteriores, devolverá un error HTTP 400 Bad Request con {"error": "invalid_grant"} como el cuerpo.
De lo contrario, utilice el ID de usuario del token de actualización para generar un token de acceso. Estos tokens pueden ser cualquier valor de cadena, pero deben representar de forma única al usuario y al cliente para el que es el token, y no deben ser adivinables. Para los tokens de acceso, también registre el tiempo de vencimiento del token, generalmente una hora después de emitir el token.

Devuelve el siguiente objeto JSON en el cuerpo de la respuesta HTTPS:

{
"token_type": "Bearer",
"access_token": " ACCESS_TOKEN ",
"expires_in": SECONDS_TO_EXPIRATION
}

Handle userinfo requests

The userinfo endpoint is an OAuth 2.0 protected resource that return claims about the linked user. Implementing and hosting the userinfo endpoint is optional, except for the following use cases:

Linked Account Sign-In with Google One Tap.
Frictionless subscription on AndroidTV.

After the access token has been successfully retrieved from your token endpoint, Google sends a request to your userinfo endpoint to retrieve basic profile information about the linked user.

userinfo endpoint request headers
`Authorization header`	The access token of type Bearer.

For example, if your userinfo endpoint is available at https://myservice.example.com/userinfo, a request might look like the following:

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

For your userinfo endpoint to handle requests, do the following steps:

Extract access token from the Authorization header and return information for the user associated with the access token.
If the access token is invalid, return an HTTP 401 Unauthorized error with using the WWW-Authenticate Response Header. Below is an example of a userinfo error response:
```
HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
```
If a 401 Unauthorized, or any other unsuccessful error response is returned during the linking process, the error will be non-recoverable, the retrieved token will be discarded and the user will have to initiate the linking process again.

If the access token is valid, return and HTTP 200 response with the following JSON object in the body of the HTTPS response:

{
"sub": "USER_UUID",
"email": "EMAIL_ADDRESS",
"given_name": "FIRST_NAME",
"family_name": "LAST_NAME",
"name": "FULL_NAME",
"picture": "PROFILE_PICTURE",
}

If your userinfo endpoint returns an HTTP 200 success response, the retrieved token and claims are registered against the user's Google account.

userinfo endpoint response
`sub`	A unique ID that identifies the user in your system.
`email`	Email address of the user.
`given_name`	Optional: First name of the user.
`family_name`	Optional: Last name of the user.
`name`	Optional: Full name of the user.
`picture`	Optional: Profile picture of the user.

Cómo validar la implementación

You can validate your implementation by using the OAuth 2.0 Playground tool.

In the tool, do the following steps:

Click Configuration to open the OAuth 2.0 Configuration window.
In the OAuth flow field, select Client-side.
In the OAuth Endpoints field, select Custom.
Specify your OAuth 2.0 endpoint and the client ID you assigned to Google in the corresponding fields.
In the Step 1 section, don't select any Google scopes. Instead, leave this field blank or type a scope valid for your server (or an arbitrary string if you don't use OAuth scopes). When you're done, click Authorize APIs.
In the Step 2 and Step 3 sections, go through the OAuth 2.0 flow and verify that each step works as intended.

You can validate your implementation by using the Google Account Linking Demo tool.

In the tool, do the following steps:

Click the Sign-in with Google button.
Choose the account you'd like to link.
Enter the service ID.
Optionally enter one or more scopes that you will request access for.
Click Start Demo.
When prompted, confirm that you may consent and deny the linking request.
Confirm that you are redirected to your platform.