Vinculación de Cuentas de Google con OAuth

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

In the implicit flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from Google.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which presents the sign-in UI to your users that aren't already signed in. The authorization endpoint also creates a short-lived authorization code to record users' consent to the requested access.

• The token exchange endpoint, which is responsible for two types of exchanges:

  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Choose an OAuth 2.0 flow

Although the implicit flow is simpler to implement, Google recommends that access tokens issued by the implicit flow never expire. This is because the user is forced to link their account again after a token expires with the implicit flow. If you need token expiration for security reasons, we strongly recommend that you use the authorization code flow instead.

Design guidelines

This section describes the design requirements and recommendations for the user screen that you host for OAuth linking flows. After it's called by Google's app, your platform displays a sign in to Google page and account linking consent screen to the user. The user is directed back to Google's app after giving their consent to link accounts.

Requirements

1. You must communicate that the user’s account will be linked to Google, not a specific Google product like Google Home or Google Assistant.

Recommendations

We recommend that you do the following:

1. Display Google's Privacy Policy. Include a link to Google’s Privacy Policy on the consent screen.

2. Data to be shared. Use clear and concise language to tell the user what data of theirs Google requires and why.

3. Clear call-to-action. State a clear call-to-action on your consent screen, such as “Agree and link.” This is because users need to understand what data they're required to share with Google to link their accounts.

4. Ability to cancel. Provide a way for users to go back or cancel, if they choose not to link.

5. Clear sign-in process. Ensure that users have clear method for signing in to their Google account, such as fields for their username and password or Sign in with Google.

6. Ability to unlink. Offer a mechanism for users to unlink, such as a URL to their account settings on your platform. Alternatively, you can include a link to Google Account where users can manage their linked account.

7. Ability to change user account. Suggest a method for users to switch their account(s). This is especially beneficial if users tend to have multiple accounts.

   • If a user must close the consent screen to switch accounts, send a recoverable error to Google so the user can sign in to the desired account with OAuth linking and the implicit flow.

8. Include your logo. Display your company logo on the consent screen. Use your style guidelines to place your logo. If you wish to also display Google's logo, see Logos and trademarks.

Create the project

To create your project to use account linking:

1. Go to the Google API Console.
2. Click Create project.
3. Enter a name or accept the generated suggestion.
4. Confirm or edit any remaining fields.
5. Click Create.

To view your project ID:

1. Go to the Google API Console.
2. Find your project in the table on the landing page. The project ID appears in the ID column.

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.

1. Open the OAuth consent screen page of the Google APIs console.
2. If prompted, select the project you just created.

3. 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 Account 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

4. 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 de OAuth

Una implementación del servidor OAuth 2.0 del flujo de código de autorización consiste en dos extremos, que tu servicio pone a disposición a través de HTTPS. El primer extremo es el extremo de autorización, que es responsable de encontrar u obtener el consentimiento de los usuarios para acceder a los datos. El extremo de autorización presenta un de acceso para los usuarios que aún no lo hayan hecho y que registren su consentimiento el acceso solicitado. El segundo extremo es el extremo de intercambio de tokens, se usa para obtener cadenas encriptadas, denominadas tokens, que autorizan al usuario a realizar acceder a tu servicio.

Cuando una aplicación de Google necesita llamar a una de las APIs de tu servicio, Google usa estos extremos a fin de obtener permiso de los usuarios para llamar a estas APIs por ellos.

Una sesión de flujo de código de autorización de OAuth 2.0 que inicia Google tiene la siguiente flujo:

1. Google abre el extremo de autorización en el navegador del usuario. Si el flujo que se inician en un dispositivo solo de voz para una Action, Google transfiere ejecución a un teléfono.
2. El usuario accede a su cuenta, si aún no lo hizo, y le otorga permiso a Google para acceder a sus datos con tu API, si aún no han otorgado permiso.
3. Tu servicio crea un código de autorización y se lo devuelve a Google. Tareas pendientes por lo que debes redireccionar el navegador del usuario de vuelta a Google con el código de autorización. que se adjuntan a la solicitud.
4. Google envía el código de autorización a tu extremo de intercambio de token, que verifica la autenticidad del código y devuelve un token de acceso y un token de actualización. El token de acceso es un token de corta duración que acepta como credenciales para acceder a las APIs. El token de actualización es de larga duración token que Google puede almacenar y usar para adquirir nuevos tokens de acceso cuando y vencer.
5. Después de que el usuario completa el flujo de vinculación de cuentas, cada que envió Google contiene un token de acceso.

Maneja solicitudes de autorización

Cuando necesitas vincular cuentas con el código de autorización de OAuth 2.0 flujo, Google envía al usuario a tu extremo de autorización con una solicitud que incluye los siguientes parámetros:

Por ejemplo, si tu extremo de autorización está disponible en https://myservice.example.com/auth, una solicitud podría verse de la siguiente manera:

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 tu extremo de autorización controle las solicitudes de acceso, haz lo siguiente pasos:

1. Verifica que client_id coincida con el ID de cliente que le asignaste a Google y que redirect_uri coincida con la URL de redireccionamiento que proporcionó Google para tu servicio. Estas verificaciones son importantes para evitar que se otorguen el acceso a apps cliente no deseadas o configuradas incorrectamente. Si admites varias Flujos de OAuth 2.0; también confirma que response_type sea code.
2. Verifica si el usuario accedió a tu servicio. Si el usuario no accedió, completar el flujo de acceso o registro del servicio.
3. Genera un código de autorización para que Google lo use para acceder a tu API. El código de autorización puede ser cualquier valor de cadena, pero debe ser representar al usuario, al cliente al que pertenece el token y el vencimiento del código el tiempo y que no debe ser adivinable. Por lo general, se emiten autorizaciones los códigos que vencen después de unos 10 minutos.
4. Confirma que la URL especificada por el parámetro redirect_uri tenga el elemento siguiente formulario:

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

5. Redireccionar el navegador del usuario a la URL especificada por el Parámetro redirect_uri. Incluya el código de autorización que que acabas de generar y el valor de estado original, sin modificar, cuando redireccionas Agregando los parámetros code y state. A continuación, se muestra un ejemplo de la URL resultante:

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

Controla las solicitudes de intercambio de tokens

El extremo de intercambio de tokens de tu servicio es responsable de dos tipos de tokens intercambios:

• Intercambia códigos de autorización por tokens de acceso y tokens de actualización
• Intercambia tokens de actualización por tokens de acceso

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

Intercambia códigos de autorización por tokens de acceso y tokens de actualización

Después de que el usuario accede y tu extremo de autorización muestra un mensaje de código de autorización a Google, Google envía una solicitud a tu intercambio de token para intercambiar el código de autorización por un token de acceso y una actualización token.

Para estas solicitudes, el valor de grant_type es authorization_code, y la El valor de code es el valor del código de autorización que otorgaste anteriormente. a Google. El siguiente es un ejemplo de una solicitud para intercambiar un Código de autorización para 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 por un token de acceso y un token de actualización, tu El extremo de intercambio de tokens responde a las solicitudes POST mediante la ejecución del siguiente comando: pasos:

1. Verifica que el client_id identifique el origen de la solicitud como un origen y que client_secret coincida con el valor esperado.
2. Verifica que el código de autorización sea válido y no haya vencido, y que el el ID de cliente especificado en la solicitud coincide con el ID de cliente asociado con el código de autorización.
3. Confirma que la URL especificada por el parámetro redirect_uri sea idéntica según el valor que se usó en la solicitud de autorización inicial.
4. Si no puedes verificar todos los criterios anteriores, devuelve una solicitud HTTP Error 400 de solicitud incorrecta con {"error": "invalid_grant"} como cuerpo.
5. De lo contrario, usa el ID de usuario del código de autorización para generar una actualización. y uno 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 deben no deben poder adivinarse. Para los tokens de acceso, registra también la fecha de vencimiento de el token, que suele ser una hora después de que se emite. Los tokens de actualización no vencen.
6. Muestra 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 los registros el vencimiento del token de acceso. Cuando vence el token de acceso, Google usa el token de actualización para obtener un nuevo token de acceso desde el extremo de intercambio del token.

Intercambia tokens de actualización por tokens de acceso

Cuando vence un token de acceso, Google envía una solicitud a tu intercambio de token extremo para intercambiar un token de actualización por un token de acceso nuevo.

Para estas solicitudes, el valor de grant_type es refresh_token, y el valor de refresh_token es el valor del token de actualización que le otorgaste anteriormente Google. El siguiente es un ejemplo de una solicitud para intercambiar un token de actualización para 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

Para intercambiar un token de actualización por un token de acceso, el extremo de intercambio del token responde a las solicitudes POST mediante la ejecución de los siguientes pasos:

1. Verifica que client_id identifique el origen de la solicitud como Google. para que client_secret coincida con el valor esperado.
2. Verifica 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.
3. Si no puedes verificar todos los criterios anteriores, muestra un error HTTP 400 Error de solicitud incorrecta con {"error": "invalid_grant"} como cuerpo.
4. De lo contrario, usa el ID de usuario del token de actualización para generar un permiso token. Estos tokens pueden ser de cualquier valor de cadena, pero deben ser únicos representan al usuario y al cliente para el que es el token, y no deben ser adivinable. Para los tokens de acceso, registra también la hora de vencimiento del token, por lo general, una hora después de emitir el token.
5. Devuelve el siguiente objeto JSON en el cuerpo del protocolo HTTPS respuesta:

   {
   "token_type": "Portador",
   “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.

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:

1. Extract access token from the Authorization header and return information for the user associated with the access token.
2. 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.

3. 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:

1. Click Configuration settings to open the OAuth 2.0 Configuration window.
2. In the OAuth flow field, select Client-side.
3. In the OAuth Endpoints field, select Custom.
4. Specify your OAuth 2.0 endpoint and the client ID you assigned to Google in the corresponding fields.
5. 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.
6. 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:

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