Kontoverknüpfung mit OAuth-basierter Google Log-in-Verknüpfung „Optimierte“

Beim OAuth-basierten Google Log-in-Verknüpfungstyp „Optimierte“ wird Google Log-in zusätzlich zur OAuth-basierten Kontoverknüpfung hinzugefügt. Dies bietet eine nahtlose sprachbasierte Verknüpfung für Google-Nutzer und gleichzeitig die Kontoverknüpfung für Nutzer, die sich nicht mit einer Google-Identität bei Ihrem Dienst registriert haben.

Dieser Verknüpfungstyp beginnt mit Google Log-in. Damit können Sie prüfen, ob die Google-Profilinformationen des Nutzers in Ihrem System vorhanden sind. Wenn die Nutzerinformationen nicht in Ihrem System gefunden werden, beginnt ein Standard-OAuth-Ablauf. Der Nutzer kann auch ein neues Konto mit seinen Google-Profilinformationen erstellen.

So erstellst du eine Kontoverknüpfung mit dem Verknüpfungstyp „Optimierte“:

1. Bitten Sie den Nutzer zuerst um Einwilligung für den Zugriff auf sein Google-Profil.
2. Die Informationen in seinem Profil verwenden, um den Nutzer zu identifizieren
3. Wenn Sie in Ihrem Authentifizierungssystem keine Übereinstimmung für den Google-Nutzer finden, wird der Ablauf abhängig davon fortgesetzt, ob Sie Ihr Actions-Projekt in der Actions Console so konfiguriert haben, dass das Erstellen von Nutzerkonten per Spracheingabe oder nur auf Ihrer Website zulässig ist.
   • Wenn Sie die Kontoerstellung per Spracheingabe zulassen, validieren Sie das von Google erhaltene ID-Token. Anschließend können Sie anhand der im ID-Token enthaltenen Profilinformationen einen Nutzer erstellen.
   • Wenn Sie die Kontoerstellung per Spracheingabe nicht zulassen, wird der Nutzer zu einem Browser weitergeleitet, wo er Ihre Autorisierungsseite laden und den Vorgang zur Nutzererstellung abschließen kann.

Kontoerstellung per Spracheingabe unterstützen

Wenn Sie die Erstellung von Nutzerkonten per Spracheingabe zulassen, fragt Assistant den Nutzer, ob er Folgendes tun möchte:

• ein neues Konto in Ihrem System mit den Google-Kontoinformationen erstellen oder
• Melden Sie sich mit einem anderen Konto in Ihrem Authentifizierungssystem an, wenn es bereits ein Nicht-Google-Konto hat.

Es empfiehlt sich, die Kontoerstellung per Spracheingabe zuzulassen, wenn Sie den Ablauf der Kontoerstellung minimieren möchten. Der Nutzer muss den Voice Flow nur verlassen, wenn er sich mit einem vorhandenen Nicht-Google-Konto anmelden möchte.

Kontoerstellung per Sprachbefehl nicht zulassen

Wenn Sie das Erstellen von Nutzerkonten per Spracheingabe nicht zugelassen haben, öffnet Assistant die URL zu der Website, die Sie für die Nutzerauthentifizierung angegeben haben. Wenn die Interaktion auf einem Gerät ohne Bildschirm erfolgt, leitet Assistant den Nutzer zu einem Smartphone weiter, um den Kontoverknüpfungsvorgang fortzusetzen.

In folgenden Fällen empfiehlt es sich, die Erstellung nicht zu untersagen:

• Sie möchten nicht, dass Nutzer, die keine Google-Konten haben, ein neues Nutzerkonto erstellen, sondern stattdessen eine Verknüpfung mit ihren vorhandenen Nutzerkonten in Ihrem Authentifizierungssystem herstellen. Wenn Sie beispielsweise ein Treuepunkteprogramm anbieten, sollten Sie darauf achten, dass der Nutzer nicht die mit seinem bestehenden Konto gesammelten Punkte verliert.

• Sie müssen die volle Kontrolle über die Kontoerstellung haben. Sie können die Erstellung beispielsweise nicht zulassen, wenn Sie dem Nutzer während der Kontoerstellung Ihre Nutzungsbedingungen anzeigen lassen möchten.

„Optimierte“ Verknüpfung mit OAuth-basiertem Google Log-in implementieren

Die Konten sind mit den branchenüblichen OAuth 2.0-Abläufen verknüpft. Actions on Google unterstützt den impliziten Vorgang und den Vorgang mit Autorisierungscode.

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.

Projekt konfigurieren

So konfigurieren Sie Ihr Projekt für die Verwendung der optimierten Verknüpfung:

1. Öffnen Sie die Actions Console und wählen Sie das gewünschte Projekt aus.
2. Klicken Sie auf den Tab Entwickeln und wählen Sie Kontoverknüpfung aus.
3. Aktivieren Sie den Schieberegler neben Kontoverknüpfung.
4. Wählen Sie im Abschnitt Kontoerstellung die Option Ja aus.

5. Wählen Sie unter Verknüpfungstyp die Optionen OAuth & Google Log-in und Impliziert aus.

   

6. Führen Sie unter Clientinformationen die folgenden Schritte aus:

   • Weisen Sie der Client-ID von Actions to Google einen Wert zu, um Anfragen von Google zu identifizieren.
   • Fügen Sie die URLs für Ihre Autorisierungs- und Token-Austausch-Endpunkte ein.

7. Klicken Sie auf Speichern.

OAuth-Server implementieren

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:

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.

Handle automatic linking

After the user gives your Action consent to access their Google profile, Google sends a request that contains a signed assertion of the Google user's identity. The assertion contains information that includes the user's Google Account ID, name, and email address. The token exchange endpoint configured for your project handles that request.

If the corresponding Google account is already present in your authentication system, your token exchange endpoint returns a token for the user. If the Google account doesn't match an existing user, your token exchange endpoint returns a user_not_found error.

The request has the following form:

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

Your token exchange endpoint must be able to handle the following parameters:

When your token exchange endpoint receives the linking request, it should do the following:

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.

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": "jan@gmail.com", // 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.

Check if the Google account is already present in your authentication system

Check whether either of the following conditions are true:

• The Google Account ID, found in the assertion's sub field, is in your user database.
• The email address in the assertion matches a user in your user database.

If either condition is true, the user has already signed up and you can issue an access token.

If neither the Google Account ID nor the email address specified in the assertion matches a user in your database, the user hasn't signed up yet. In this case, your token exchange endpoint should reply with a HTTP 401 error, that specifies error=user_not_found, as in the following example:

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

{
  "error":"user_not_found",
}

Kontoerstellung über Google Log-in durchführen

Wenn ein Nutzer bei Ihrem Dienst ein Konto erstellen muss, erstellt Google ein an Ihren Tokenaustausch-Endpunkt senden, der Folgendes angibt: intent=create, wie im folgenden Beispiel:

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]

Der Parameter assertion enthält ein JSON-Webtoken (JWT), das eine signierte Bestätigung der Identität des Google-Nutzers. Das JWT enthält Informationen die die Google-Konto-ID, den Namen und die E-Mail-Adresse des Nutzers enthält, die Sie um ein neues Konto für Ihren Dienst zu erstellen.

Um auf Anfragen zur Kontoerstellung zu antworten, muss Ihr Endpunkt für den Tokenaustausch Folgendes tun Folgendes:

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.

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": "jan@gmail.com", // 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.

Nutzerinformationen validieren und neues Konto erstellen

Prüfen Sie, ob eine der folgenden Bedingungen erfüllt ist:

• Die Google-Konto-ID, die Sie im Feld sub der Assertion finden, befindet sich in Ihrer Nutzerdatenbank.
• Die E-Mail-Adresse in der Assertion stimmt mit einem Nutzer in Ihrer Nutzerdatenbank überein.

Wenn eine der Bedingungen zutrifft, fordern Sie den Nutzer auf, sein bestehendes Konto mit zu verknüpfen. mit einem HTTP 401-Fehler auf die Anfrage antworten und angeben, error=linking_error und die E-Mail-Adresse des Nutzers als login_hint, wie im folgendes Beispiel:

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

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

Wenn keine der beiden Bedingungen zutrifft, erstellen Sie mithilfe der Informationen ein neues Nutzerkonto. die im JWT bereitgestellt werden. Für neue Konten wird normalerweise kein Passwort festgelegt. Es ist empfohlen, Google Log-in auf anderen Plattformen hinzuzufügen, damit sich Nutzer anmelden können über Google für alle Oberflächen Ihrer App verfügbar. Alternativ können Sie Senden Sie dem Nutzer per E-Mail einen Link, mit dem die Passwortwiederherstellung gestartet wird, damit der Nutzer ein Passwort für die Anmeldung auf anderen Plattformen.

Wenn die Erstellung abgeschlossen ist, geben Sie ein Zugriffstoken aus und geben die Werte in einem JSON-Objekt in den Text Ihrer HTTPS-Antwort ein, wie im folgenden Beispiel:

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

Die Sprach-Benutzeroberfläche für den Authentifizierungsablauf entwerfen

Prüfe, ob der Nutzer bestätigt ist, und starte den Vorgang zur Kontoverknüpfung

1. Öffnen Sie Ihr Actions Builder-Projekt in der Actions Console.
2. Erstelle eine neue Szene, um die Kontoverknüpfung in deiner Aktion zu starten:
   1. Klicken Sie auf Szenen.
   2. Klicken Sie auf das Symbol Hinzufügen (+), um eine neue Szene hinzuzufügen.
3. Klicken Sie in der neu erstellten Szene auf das Symbol add zum Hinzufügen von Bedingungen.
4. Fügen Sie eine Bedingung hinzu, die prüft, ob der mit der Unterhaltung verknüpfte Nutzer ein bestätigter Nutzer ist. Wenn die Prüfung fehlschlägt, kann deine Aktion während der Unterhaltung keine Kontoverknüpfung vornehmen und sollte auf Funktionen zugreifen, für die keine Kontoverknüpfung erforderlich ist.
   1. Geben Sie im Feld Enter new expression unter Bedingung die folgende Logik ein: user.verificationStatus != "VERIFIED"
   2. Wählen Sie unter Übergang eine Szene aus, für die keine Kontoverknüpfung erforderlich ist, oder eine Szene, die der Einstiegspunkt für die Funktion nur für Gäste ist.

1. Klicken Sie unter Conditions (Bedingungen) auf das Symbol zum Hinzufügen add.
2. Fügen Sie eine Bedingung hinzu, um einen Kontoverknüpfungsvorgang auszulösen, wenn der Nutzer keine verknüpfte Identität hat.
   1. Geben Sie im Feld Enter new expression unter Bedingung die folgende Logik ein: user.verificationStatus == "VERIFIED"
   2. Wählen Sie unter Umstellung die Systemszene Kontoverknüpfung aus.
   3. Klicken Sie auf Speichern.

Nach dem Speichern wird dem Projekt eine neue Systemszene zur Kontoverknüpfung mit dem Namen <SceneName>_AccountLinking hinzugefügt.

Szene für die Kontoverknüpfung anpassen

1. Wählen Sie unter Szenen die Systemszene für die Kontoverknüpfung aus.
2. Klicke auf Prompt senden und füge einen kurzen Satz hinzu, um dem Nutzer zu beschreiben, warum die Aktion auf seine Identität zugreifen muss (z. B. „Zum Speichern deiner Einstellungen“).
3. Klicken Sie auf Speichern.

1. Klicken Sie unter Bedingungen auf Wenn der Nutzer die Kontoverknüpfung erfolgreich abschließt.
2. Legen Sie fest, wie der Ablauf ausgeführt werden soll, wenn der Nutzer der Verknüpfung seines Kontos zustimmt. Rufen Sie beispielsweise den Webhook auf, um die erforderliche benutzerdefinierte Geschäftslogik zu verarbeiten und zurück zur ursprünglichen Szene zu wechseln.
3. Klicken Sie auf Speichern.

1. Klicken Sie unter Bedingungen auf Wenn der Nutzer die Kontoverknüpfung aufhebt oder ablehnt.
2. Legen Sie fest, wie der Ablauf ausgeführt werden soll, wenn der Nutzer der Verknüpfung seines Kontos nicht zustimmt. Sie können beispielsweise eine Bestätigungsnachricht senden und zu Szenen weiterleiten, die Funktionen bieten, für die keine Kontoverknüpfung erforderlich ist.
3. Klicken Sie auf Speichern.

1. Klicken Sie unter Bedingungen auf Bei System- oder Netzwerkfehlern.
2. Legen Sie fest, wie der Ablauf ausgeführt werden soll, wenn der Kontoverknüpfungsvorgang aufgrund von System- oder Netzwerkfehlern nicht abgeschlossen werden kann. Sie können beispielsweise eine Bestätigungsnachricht senden und zu Szenen weiterleiten, die Funktionen bieten, für die keine Kontoverknüpfung erforderlich ist.
3. Klicken Sie auf Speichern.

Datenzugriffsanfragen verarbeiten

Wenn die Assistant-Anfrage ein Zugriffstoken enthält, prüfen Sie zuerst, ob das Zugriffstoken gültig und nicht abgelaufen ist. Rufen Sie dann das mit dem Token verknüpfte Nutzerkonto aus der Nutzerkontodatenbank ab.