Связывание аккаунта Google с OAuth

Связывание учетных записей осуществляется с использованием стандартных для отрасли потоков неявной авторизации OAuth 2.0 и кодов авторизации .

Внимание: Неявный поток не поддерживается для потоков MCP, UCP и потоков, управляемых агентом. Как правило, его использование не рекомендуется для всех новых интеграций. Вместо этого используйте поток кода авторизации .

Ваш сервис должен поддерживать авторизацию и конечные точки обмена токенами , соответствующие стандарту OAuth 2.0.

В рамках неявного процесса Google открывает вашу конечную точку авторизации в браузере пользователя. После успешного входа в систему вы возвращаете Google долговременный токен доступа. Этот токен доступа теперь включается в каждый запрос, отправляемый Google.

В процессе авторизации с использованием кода авторизации вам потребуются две конечные точки:

• Конечная точка авторизации , которая отображает пользовательский интерфейс входа в систему для пользователей, которые еще не авторизованы. Конечная точка авторизации также создает кратковременный код авторизации для регистрации согласия пользователей на запрашиваемый доступ.

• Конечная точка обмена токенов , отвечающая за два типа обмена:

  1. Обменивает код авторизации на долгосрочный токен обновления и краткосрочный токен доступа. Этот обмен происходит, когда пользователь проходит процедуру привязки учетной записи.
  2. Обменивает долгосрочный токен обновления на краткосрочный токен доступа. Этот обмен происходит, когда Google требуется новый токен доступа, поскольку срок действия предыдущего истек.

Выберите алгоритм аутентификации OAuth 2.0.

Хотя неявный поток проще в реализации, Google рекомендует, чтобы токены доступа, выданные с помощью неявного потока, никогда не истекали. Это связано с тем, что после истечения срока действия токена в неявном потоке пользователю приходится повторно привязывать свою учетную запись. Если истечение срока действия токена необходимо по соображениям безопасности, мы настоятельно рекомендуем использовать поток авторизационного кода .

Примечание: Используйте следующие кнопки, чтобы выбрать, какой поток OAuth 2.0 вы хотите реализовать. При необходимости содержимое этого руководства будет обновлено в соответствии с вашим выбором.

Неявный поток Код авторизации

Рекомендации по проектированию

В этом разделе описываются требования к дизайну и рекомендации для пользовательского экрана, который вы размещаете для потоков привязки OAuth. После вызова из приложения Google ваша платформа отображает пользователю страницу входа в Google и экран согласия на привязку учетной записи. Пользователь возвращается в приложение Google после предоставления согласия на привязку учетных записей.

Рисунок 1. Экраны входа пользователя в Google и подтверждения согласия при привязке учетной записи.

Требования

1. Необходимо сообщить пользователю, что его учетная запись будет привязана к Google, а не к конкретному продукту Google, такому как Google Home или Google Assistant.

Рекомендации

Мы рекомендуем вам сделать следующее:

1. Отобразите политику конфиденциальности Google. Включите ссылку на политику конфиденциальности Google на экране согласия.

2. Данные, которыми необходимо поделиться. Используйте ясный и лаконичный язык, чтобы сообщить пользователю, какие его данные Google запрашивает и почему.

3. Четкий призыв к действию. На экране согласия четко сформулируйте призыв к действию, например, «Согласиться и связать». Это необходимо, поскольку пользователи должны понимать, какие данные им необходимо предоставить Google для связи своих учетных записей.

4. Возможность отмены. Предоставьте пользователям возможность вернуться назад или отменить подписку, если они не захотят использовать ссылку.

5. Четкий процесс входа в систему. Убедитесь, что у пользователей есть понятный способ входа в свою учетную запись Google, например, поля для имени пользователя и пароля или возможность входа через Google .

6. Возможность отвязать аккаунт. Предоставьте пользователям механизм для отвязки аккаунта, например, ссылку на настройки их учетной записи на вашей платформе. В качестве альтернативы вы можете добавить ссылку на учетную запись Google, где пользователи смогут управлять связанным аккаунтом.

7. Возможность смены учетной записи пользователя. Предложите пользователям способ смены учетных записей. Это особенно полезно, если у пользователей обычно несколько учетных записей.

   • Если пользователю необходимо закрыть экран согласия для переключения между учетными записями, отправьте в Google устранимую ошибку, чтобы пользователь мог войти в нужную учетную запись с помощью привязки OAuth и неявного потока аутентификации.

8. Добавьте свой логотип. Отобразите логотип вашей компании на экране согласия. Используйте свои рекомендации по стилю для размещения логотипа. Если вы также хотите отобразить логотип Google, см. раздел «Логотипы и товарные знаки» .

Рисунок 2. Рекомендации по дизайну экранов входа пользователя в Google и экранов согласия.

Create the project

Note: You can reuse an existing project and do not need to create a new project primarily for account linking.

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.

Реализуйте свой OAuth-сервер.

н

Внимание: неявный поток не поддерживается для потоков MCP, UCP и потоков, управляемых агентами. Как правило, его использование не рекомендуется для всех новых интеграций из соображений безопасности. Вместо этого используйте поток кода авторизации .

Для поддержки неявного потока OAuth 2.0 ваш сервис предоставляет конечную точку авторизации по протоколу HTTPS. Эта конечная точка отвечает за аутентификацию и получение согласия пользователей на доступ к данным. Конечная точка авторизации отображает пользователям, которые еще не авторизованы, интерфейс входа в систему и регистрирует согласие на запрошенный доступ.

Когда приложению Google необходимо вызвать один из авторизованных API вашего сервиса, Google использует эту конечную точку, чтобы получить разрешение от ваших пользователей на вызов этих API от их имени.

Привязка учетной записи Google: неявный поток OAuth.

На приведенной ниже диаграмме подробно описаны взаимодействия между пользователем, Google и конечными точками вашего сервиса.

Рисунок 1. Последовательность событий в неявном потоке OAuth 2.0 для привязки учетной записи Google.

Роли и обязанности

В таблице ниже определены роли и обязанности участников процесса неявной аутентификации OAuth через Google Account Linking (GAL). Обратите внимание, что в GAL Google выступает в роли клиента OAuth, а ваш сервис — в роли поставщика идентификации/услуг .

Актер / Компонент	Роль GAL	Обязанности
Приложение/сервер Google	Клиент OAuth	Запускает процесс, получает токен доступа посредством перенаправления в браузере и безопасно сохраняет его для доступа к API вашего сервиса.
Ваша точка авторизации	Сервер авторизации	Аутентифицирует ваших пользователей, получает их согласие и выдает Google токены доступа с длительным сроком действия.
URI перенаправления Google	Конечная точка обратного вызова	Получает перенаправление пользователя от вашей службы авторизации со значениями access_token и state во фрагменте URL.

Типичная сессия неявного потока OAuth 2.0, инициированная Google, имеет следующий характер:

1. Google открывает вашу точку авторизации в браузере пользователя. Пользователь входит в систему, если он еще не вошел, и предоставляет Google разрешение на доступ к своим данным через ваш API, если он еще не предоставил такое разрешение.
2. Ваш сервис создает токен доступа и возвращает его в Google. Для этого перенаправьте браузер пользователя обратно на сайт Google, прикрепив токен доступа к запросу.
3. Google обращается к API вашего сервиса и прикрепляет токен доступа к каждому запросу. Ваш сервис проверяет, предоставляет ли токен доступа Google разрешение на доступ к API, а затем завершает вызов API.

Обработка запросов на авторизацию

Когда приложению Google необходимо выполнить привязку учетной записи с использованием неявного потока OAuth 2.0, Google направляет пользователя на вашу конечную точку авторизации с запросом, содержащим следующие параметры:

Параметры конечной точки авторизации
client_id	Идентификатор клиента, который вы присвоили Google.
redirect_uri	URL-адрес, на который вы отправляете ответ на этот запрос.
state	Бухгалтерское значение, которое передается обратно в Google в неизмененном виде в URI перенаправления.
response_type	Тип возвращаемого значения в ответе. Для неявного потока OAuth 2.0 тип ответа всегда равен token .
user_locale	Языковые настройки учетной записи Google в формате RFC5646 используются для локализации контента на предпочитаемый пользователем язык.

Например, если ваша точка авторизации доступна по адресу https://myservice.example.com/auth , запрос может выглядеть следующим образом:

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

Для обработки запросов на вход в систему через точку авторизации выполните следующие действия:

1. Проверьте значения client_id и redirect_uri , чтобы предотвратить предоставление доступа непредусмотренным или неправильно настроенным клиентским приложениям:

   • Убедитесь, что client_id совпадает с идентификатором клиента, который вы присвоили Google.
   • Убедитесь, что URL-адрес, указанный параметром redirect_uri , имеет следующий вид:

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

2. Проверьте, вошел ли пользователь в вашу систему. Если пользователь не вошел в систему, завершите процедуру входа или регистрации в вашей системе.

3. Сгенерируйте токен доступа для Google, который будет использоваться для доступа к вашему API. Токен доступа может быть любым строковым значением, но он должен однозначно представлять пользователя и клиент, для которого предназначен токен, и не должен быть угадываемым.

4. Отправьте HTTP-ответ, который перенаправит браузер пользователя на URL-адрес, указанный параметром redirect_uri . Включите все следующие параметры в фрагмент URL-адреса:

   • access_token : Токен доступа, который вы только что сгенерировали.
   • token_type : Строковый bearer
   • state : Неизмененное значение состояния из исходного запроса.

   Ниже приведён пример результирующего URL-адреса:

   https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Обработчик перенаправлений OAuth 2.0 от Google получает токен доступа и подтверждает, что значение state не изменилось. После получения токена доступа к вашему сервису Google прикрепляет этот токен к последующим вызовам API вашего сервиса.

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:

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.

Проверка вашей реализации

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

In the tool, do the following steps:

1. Click Configuration 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.