Łączenie kont z łączeniem Logowania przez Google opartym na protokole OAuth

Typ połączenia „Uproszczone” logowanie przez Google oparte na OAuth dodaje logowanie przez Google do połączenia konta opartego na OAuth. Umożliwia to bezproblemowe łączenie kont za pomocą głosu dla użytkowników Google, a także łączenie kont użytkowników, którzy zarejestrowali się w Twojej usłudze za pomocą tożsamości innej niż Google.

Ten typ połączenia zaczyna się od logowania przez Google, które umożliwia sprawdzenie, czy informacje z profilu Google użytkownika znajdują się w Twoim systemie. Jeśli informacji o użytkowniku nie ma w Twoim systemie, rozpoczyna się standardowy proces OAuth. Użytkownik może też utworzyć nowe konto, korzystając z informacji z profilu Google.

Ilustracja 1. Po uzyskaniu przez Twoją czynność dostępu do profilu Google użytkownika możesz go użyć do znalezienia odpowiednika użytkownika w swoim systemie uwierzytelniania.

Aby połączyć konta za pomocą uproszczonego połączenia, wykonaj te ogólne czynności:

1. Najpierw poproś użytkownika o zgodę na dostęp do jego profilu Google.
2. Użyj informacji z profilu, aby zidentyfikować użytkownika.
3. Jeśli w systemie uwierzytelniania nie znajdziesz odpowiednika użytkownika Google, proces będzie przebiegać w zależności od tego, czy projekt działania został skonfigurowany w konsoli Actions tak, aby zezwalać na tworzenie kont użytkowników za pomocą głosu, czy tylko na stronie internetowej.
   • Jeśli zezwalasz na tworzenie konta za pomocą głosu, zweryfikuj token identyfikatora otrzymany od Google. Następnie możesz utworzyć użytkownika na podstawie informacji o profilu zawartych w tokenie identyfikatora.
   • Jeśli nie zezwalasz na tworzenie konta za pomocą głosu, użytkownik zostanie przekierowany do przeglądarki, w której może otworzyć stronę autoryzacji i dokończyć proces tworzenia konta.

Rysunek 2. Wizualizacja procesu OAuth i logowania przez Google, gdy informacji o użytkowniku nie ma w Twoim systemie.

Obsługa tworzenia konta za pomocą głosu

Jeśli zezwalasz na tworzenie kont użytkowników za pomocą głosu, Asystent pyta użytkownika, czy chce:

• utworzyć nowe konto w swoim systemie, używając informacji z konta Google użytkownika,
• Zaloguj się w systemie uwierzytelniania za pomocą innego konta, jeśli użytkownik ma już konto inne niż Google.

Jeśli chcesz zminimalizować trudności związane z procesem tworzenia konta, zalecamy włączenie tworzenia konta za pomocą głosu. Użytkownik musi opuścić przepływ głosowy tylko wtedy, gdy chce zalogować się za pomocą istniejącego konta innego niż Google.

Blokowanie tworzenia konta za pomocą głosu

Jeśli nie zezwolisz na tworzenie kont użytkowników za pomocą głosu, Asystent otworzy adres URL witryny, którą podasz na potrzeby uwierzytelniania użytkowników. Jeśli interakcja odbywa się na urządzeniu bez ekranu, Asystent kieruje użytkownika na telefon, aby kontynuować proces łączenia kont.

Zalecamy zablokowanie tworzenia, jeśli:

• Nie chcesz zezwalać użytkownikom z kontami innymi niż Google na tworzenie nowych kont użytkowników, ale chcesz, aby zamiast tego łączyli się z istniejącymi kontami użytkowników w Twoim systemie uwierzytelniania. Jeśli na przykład oferujesz program lojalnościowy, możesz chcieć mieć pewność, że użytkownik nie straci punktów zgromadzonych na dotychczasowym koncie.

• Musisz mieć pełną kontrolę nad procesem tworzenia konta. Możesz na przykład zablokować tworzenie konta, jeśli podczas tego procesu musisz wyświetlić użytkownikowi warunki usługi.

Uwaga: aby dowiedzieć się więcej o wdrażaniu wybranego procesu, wybierz jedną z opcji poniżej. W razie potrzeby zawartość przewodnika zostanie ponownie wczytana, aby dostosować się do Twojego wyboru.

Zezwalaj na tworzenie konta za pomocą głosu Nie zezwalaj na tworzenie konta za pomocą głosu

Wdrożenie uproszczonego łączenia kont za pomocą logowania przez Google opartego na OAuth

Konta są łączone za pomocą standardowych przepływów OAuth 2.0. Actions on Google obsługuje procesy niejawne i z kodem autoryzacji.

Uwaga: jeśli wdrażasz łączenie kont w celu obsługi informacji finansowych, pamiętaj, że Twoja czynność może podlegać dodatkowym zasadom. Sprawdzenie działania z połączeniem konta pod kątem informacji finansowych może potrwać do 6 tygodni, więc uwzględnij ten czas w harmonogramie publikacji. Aby ułatwić proces sprawdzania, przed przesłaniem działania do sprawdzenia upewnij się, że jest ono zgodne z zasadami dotyczącymi usług finansowych.

In the implicit code 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 the Assistant to your Action.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
• 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.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

Note: Please choose which OAuth 2.0 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

Konfigurowanie projektu

Aby skonfigurować projekt pod kątem uproszczonego łączenia, wykonaj te czynności:

1. Otwórz konsolę Actions i wybierz projekt, którego chcesz użyć.
2. Kliknij kartę Tworzenie i wybierz Łączenie kont.
3. Włącz przełącznik obok opcji Łączenie kont.
4. W sekcji Tworzenie konta wybierz Tak.

5. W sekcji Typ połączenia wybierz OAuth i logowanie przez Google oraz Pośredni.

   

6. W sekcji Informacje o kliencie wykonaj te czynności:

   • Przypisz wartość do pola Identyfikator klienta wydany przez Twoje działania w Google, aby identyfikować żądania pochodzące z Google.
   • Wstaw adresy URL punktów końcowych autoryzacji i wymiany tokenów.

7. Kliknij Zapisz.

Wdrażanie serwera OAuth

To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.

When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.

A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:

1. Google opens your authorization endpoint in the user's browser. The user signs in if not signed in already, and grants Google permission to access their data with your API if they haven't already granted permission.
2. Your service creates an access token and returns it to Google by redirecting the user's browser back to Google with the access token attached to the request.
3. Google calls your service's APIs, and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.

Handle authorization requests

When your Action needs to perform account linking via an OAuth 2.0 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:

Authorization endpoint parameters
client_id	The client ID you assigned to Google.
redirect_uri	The URL to which you send the response to this request.
state	A bookkeeping value that is passed back to Google unchanged in the redirect URI.
response_type	The type of value to return in the response. For the OAuth 2.0 implicit flow, the response type is always token.

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

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

For your authorization endpoint to handle sign-in requests, do the following steps:

1. Verify the client_id and redirect_uri values to prevent granting access to unintended or misconfigured client apps:

   • Confirm that the client_id matches the client ID you assigned to Google.
   • Confirm that the URL specified by the redirect_uri parameter has the following form:

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

     YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.

2. Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.

3. Generate an access token that Google will use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.

4. Send an HTTP response that redirects the user's browser to the URL specified by the redirect_uri parameter. Include all of the following parameters in the URL fragment:

   • access_token: the access token you just generated
   • token_type: the string bearer
   • state: the unmodified state value from the original request The following is an example of the resulting URL:

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

Google's OAuth 2.0 redirect handler will receive the access token and confirm that the state value hasn't changed. After Google has obtained an access token for your service, Google will attach the token to subsequent calls to your Action as part of the AppRequest.

Obsługa automatycznego łączenia

Gdy użytkownik wyrazi zgodę na dostęp do profilu Google, Google wysyła żądanie zawierające podpisane potwierdzenie tożsamości użytkownika Google. Potwierdzenie zawiera informacje, które obejmują identyfikator konta Google użytkownika, jego nazwę i adres e-mail. Punkt końcowy wymiany tokenów skonfigurowany na potrzeby projektu obsługuje tę prośbę.

Jeśli w systemie uwierzytelniania już istnieje odpowiednie konto Google, punkt końcowy wymiany tokenów zwraca token użytkownika. Jeśli konto Google nie pasujące do istniejącego użytkownika, punkt końcowy wymiany tokenów zwraca błąd user_not_found.

Prośba ma taki format:

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

grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES

Punkt końcowy wymiany tokenów musi obsługiwać te parametry:

Parametry punktu końcowego tokena
grant_type	Typ wymienianego tokena. W przypadku tych żądań ma wartość urn:ietf:params:oauth:grant-type:jwt-bearer.
intent	W przypadku tych żądań wartość tego parametru to „get”.
assertion	Token internetowy JSON (JWT), który stanowi podpisane potwierdzenie uwierzytelniania Google tożsamości użytkownika. Token JWT zawiera informacje o Google użytkownika Identyfikator konta, imię i nazwisko oraz adres e-mail.
consent_code	Opcjonalnie: jeśli jest dostępny, jednorazowy kod, który wskazuje, że użytkownik wyraził zgodę na dostęp Twojej akcji do określonych zakresów.
scope	Opcjonalne: wszystkie zakresy skonfigurowane przez Google, aby żądać od użytkowników.

Gdy punkt końcowy wymiany tokenów otrzyma żądanie połączenia, powinien wykonać :

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.

Note: The keys should not be hardcoded. Instead, follow OpenID connect discovery protocol and check the cache-control header to decide how long the key should be cached.

When decoded, the JWT assertion looks like the following example:

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com and that the audience (aud field) is the client ID assigned to your Action.

Sprawdź, czy konto Google znajduje się już w systemie uwierzytelniania

Sprawdź, czy spełniony jest jeden z tych warunków:

• Identyfikator konta Google znajdujący się w polu sub potwierdzenia znajduje się w bazie danych użytkowników.
• Adres e-mail podany w potwierdzeniu pasuje do użytkownika w bazie danych użytkowników.

Jeśli którykolwiek z tych warunków jest spełniony, użytkownik już się zarejestrował, więc możesz wysłać token dostępu.

Jeśli ani identyfikator konta Google, ani adres e-mail podany w potwierdzeniu pasuje do użytkownika w bazie danych, nie zarejestrował się jeszcze. W takim przypadku atrybut Punkt końcowy wymiany tokenów powinien odpowiedzieć z błędem HTTP 401, który określa error=user_not_found, Jak w tym przykładzie:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"user_not_found",
}

Gdy Google otrzyma odpowiedź o błędzie 401 z błędem user_not_found, Google wywołuje punkt końcowy wymiany tokenów wartością parametru intent ustaw na create (utwórz) i wysyłaj token tożsamości zawierający informacje o profilu użytkownika; z prośbą o pozwolenie.

Utwórz konto za pomocą Logowania przez Google

Gdy użytkownik musi utworzyć konto w Twojej usłudze, Google żądanie do punktu końcowego wymiany tokenów, który określa intent=create jak w tym przykładzie:

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

response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]

Parametr assertion zawiera token sieciowy JSON (JWT), który udostępnia podpisane potwierdzenie tożsamości użytkownika Google. Token JWT zawiera informacje obejmujący identyfikator konta Google użytkownika, imię i nazwisko oraz adres e-mail, aby utworzyć nowe konto w usłudze.

Aby odpowiadać na żądania utworzenia konta, punkt końcowy wymiany tokenów musi wykonać następujące:

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys (available in JWK or PEM format) to verify the token's signature.

Note: The keys should not be hardcoded. Instead, follow OpenID connect discovery protocol and check the cache-control header to decide how long the key should be cached.

When decoded, the JWT assertion looks like the following example:

{
  "sub": 1234567890,        // The unique ID of the user's Google Account
  "iss": "https://accounts.google.com",        // The assertion's issuer
  "aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
  "iat": 233366400,         // Unix timestamp of the assertion's creation time
  "exp": 233370000,         // Unix timestamp of the assertion's expiration time
  "name": "Jan Jansen",
  "given_name": "Jan",
  "family_name": "Jansen",
  "email": "[e-mail]", // If present, the user's email address
  "locale": "en_US"
}

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com and that the audience (aud field) is the client ID assigned to your Action.

Zweryfikuj informacje o użytkowniku i utwórz nowe konto

Sprawdź, czy spełniony jest jeden z tych warunków:

• Identyfikator konta Google znajdujący się w polu sub potwierdzenia znajduje się w bazie danych użytkowników.
• Adres e-mail podany w potwierdzeniu pasuje do użytkownika w bazie danych użytkowników.

Jeśli którykolwiek z tych warunków jest spełniony, poproś użytkownika o połączenie istniejącego konta swojego konta Google, odpowiadając na żądanie z błędem HTTP 401, określając error=linking_error, a adres e-mail użytkownika w polu login_hint, na przykład następujący przykład:

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
  "error":"linking_error",
  "login_hint":"[e-mail]"
}

Jeśli żaden z tych warunków nie jest spełniony, utwórz nowe konto użytkownika przy użyciu tych informacji podane w tokenie JWT. Nowe konta zwykle nie mają ustawionego hasła. Jest zalecamy dodanie Logowania przez Google na innych platformach, aby umożliwić użytkownikom logowanie w różnych miejscach aplikacji. Ewentualnie możesz wyślij użytkownikowi e-maila z linkiem, który rozpoczyna proces odzyskiwania hasła, aby umożliwić użytkownikowi ustawienie hasła do logowania się na innych platformach.

Po zakończeniu tworzenia wydaj token dostępu i zwracają wartości w obiekcie JSON w treść odpowiedzi HTTPS, jak w tym przykładzie:

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

Zaprojektuj interfejs głosowy dla procesu uwierzytelniania.

Ostrzeżenie: nie wyświetlaj użytkownikom na początku rozmowy z Twoją akcją monitu o połączenie konta. Zamiast tego udostępnij nieuwierzytelnionym użytkownikom przepływ gościa, aby pokazać, jak działa Twoja akcja, a potem poproś o połączenie konta tylko wtedy, gdy jest to konieczne do dalszego działania. Jeśli użytkownicy stale opuszczają działanie z powodu problemów z łączeniem kont, Google nie będzie aktywnie promować tego działania, co może zmniejszyć ruch użytkowników.

Uwaga: aby utworzyć działanie, które implementuje łączenie kont, musisz użyć narzędzia Actions Builder.

Sprawdź, czy użytkownik jest zweryfikowany, i rozpocznij proces łączenia konta.

1. Otwórz projekt w Actions Builder w konsoli Actions.
2. Utwórz nową scenę, aby rozpocząć łączenie kont w swojej akcji:
   1. Kliknij Sceny.
   2. Kliknij ikonę dodawania (+), aby dodać nową scenę.
3. W nowo utworzonej scenie kliknij ikonę dodawania  obok Warunków.
4. Dodaj warunek, który sprawdza, czy użytkownik powiązany z rozmową jest zweryfikowany. Jeśli weryfikacja się nie powiedzie, Akcja nie będzie mogła połączyć kont podczas rozmowy i powinna wrócić do udostępniania funkcji, które nie wymagają łączenia kont.
   1. W polu Enter new expression w sekcji Warunek wpisz tę logikę: user.verificationStatus != "VERIFIED"
   2. W sekcji Przejście wybierz scenę, która nie wymaga połączenia konta, lub scenę, która jest punktem wejścia do funkcji dostępnych tylko dla gości.

1. Kliknij ikonę dodawania  obok pozycji Warunki.
2. Dodaj warunek, który uruchomi proces łączenia kont, jeśli użytkownik nie ma powiązanej tożsamości.
   1. W polu Enter new expression w sekcji Warunek wpisz tę logikę:user.verificationStatus == "VERIFIED"
   2. W sekcji Przejście wybierz scenę systemową Łączenie kont.
   3. Kliknij Zapisz.

Po zapisaniu do projektu zostanie dodana nowa scena systemu łączenia kont o nazwie <SceneName>_AccountLinking.

Dostosowywanie sceny łączenia kont

1. W sekcji Sceny wybierz scenę systemu łączenia kont.
2. Kliknij Wyślij prompt i dodaj krótkie zdanie, aby wyjaśnić użytkownikowi, dlaczego działanie potrzebuje dostępu do jego tożsamości (np. „Aby zapisać Twoje ustawienia”).
3. Kliknij Zapisz.

1. W sekcji Warunki kliknij Jeśli użytkownik pomyślnie połączy konta.
2. Skonfiguruj, jak ma przebiegać proces, jeśli użytkownik zgodzi się na połączenie konta. Możesz na przykład wywołać webhooka, aby przetworzyć dowolną niestandardową logikę biznesową i wrócić do pierwotnej sceny.
3. Kliknij Zapisz.

1. W sekcji Warunki kliknij Jeśli użytkownik anuluje połączenie konta lub je odrzuci.
2. Skonfiguruj, jak ma przebiegać proces, jeśli użytkownik nie zgodzi się na połączenie konta. Możesz na przykład wysłać wiadomość z potwierdzeniem i przekierować użytkownika do scen, które zapewniają funkcje niewymagające połączenia kont.
3. Kliknij Zapisz.

1. W sekcji Warunki kliknij Jeśli wystąpi błąd systemu lub sieci.
2. Skonfiguruj, jak ma przebiegać proces, jeśli nie można go ukończyć z powodu błędów systemu lub sieci. Możesz na przykład wysłać wiadomość z potwierdzeniem i przekierować użytkownika do scen, które zapewniają funkcje niewymagające połączenia kont.
3. Kliknij Zapisz.

Obsługa próśb o dostęp do danych

Jeśli żądanie Asystenta zawiera token dostępu, najpierw sprawdź, czy jest on ważny i nie wygasł, a potem pobierz z bazy danych kont użytkowników konto powiązane z tym tokenem.