Collegamento dell'account con il collegamento "semplificato" di Accedi con Google basato su OAuth

Il tipo di collegamento "semplificato" di Accedi con Google basato su OAuth aggiunge Accedi con Google in aggiunta al collegamento dell'account basato su OAuth. In questo modo, gli utenti Google possono collegare facilmente i propri account tramite comandi vocali, mentre gli utenti che si sono registrati al tuo servizio con un'identità non Google possono collegare i propri account.

Questo tipo di collegamento inizia con Accedi con Google, che ti consente di verificare se le informazioni del profilo Google dell'utente esistono nel tuo sistema. Se le informazioni dell'utente non vengono trovate nel tuo sistema, inizia un flusso OAuth standard. L'utente può anche scegliere di creare un nuovo account con le informazioni del suo profilo Google.

Figura 1: dopo che l'azione ha ottenuto l'accesso al profilo Google dell'utente, puoi utilizzarlo per trovare una corrispondenza per l'utente nel tuo sistema di autenticazione.

Per eseguire il collegamento degli account con il tipo di collegamento semplificato, segui questi passaggi generali:

  1. Per prima cosa, chiedi all'utente di dare il consenso per accedere al suo profilo Google.
  2. Utilizza le informazioni nel profilo per identificare l'utente.
  3. Se non riesci a trovare una corrispondenza per l'utente Google nel tuo sistema di autenticazione, il flusso procede a seconda che tu abbia configurato il tuo progetto Azioni nella console Azioni per consentire la creazione di account utente tramite voce o solo sul tuo sito web.
    • Se consenti la creazione di account tramite comandi vocali, convalida il token ID ricevuto da Google. Puoi quindi creare un utente in base alle informazioni del profilo contenute nel token ID.
    • Se non consenti la creazione di account tramite la voce, l'utente viene trasferito a un browser in cui può caricare la tua pagina di autorizzazione e completare il flusso di creazione dell'utente.
Se consenti la creazione di account tramite voce e non riesci a trovare una corrispondenza per
            il profilo Google nel tuo sistema di autenticazione, devi
            convalidare il token ID ricevuto da Google. Puoi quindi creare un utente in base alle informazioni del profilo contenute nel token ID.
            Se non consenti la creazione di account utente tramite comandi vocali, l'utente viene
            trasferito a un browser in cui può caricare la pagina di autorizzazione
            e completare il flusso.
Figura 2. Una rappresentazione visiva del flusso di OAuth e Accedi con Google quando le informazioni di un utente non vengono trovate nel tuo sistema.

Supportare la creazione di account tramite voce

Se consenti la creazione di account utente tramite comandi vocali, l'assistente chiede all'utente se vuole fare quanto segue:

  • Crea un nuovo account sul tuo sistema utilizzando le informazioni del suo Account Google oppure
  • Accedi al tuo sistema di autenticazione con un altro account se hai un account non Google esistente.

La creazione dell'account tramite comandi vocali è consigliata se vuoi ridurre al minimo l'attrito del flusso di creazione dell'account. L'utente deve uscire dal flusso vocale solo se vuole accedere utilizzando un account non Google esistente.

Non consentire la creazione di account tramite comandi vocali

Se non hai consentito la creazione di account utente tramite la voce, l'assistente apre l'URL del sito web che hai fornito per l'autenticazione utente. Se l'interazione avviene su un dispositivo senza schermo, l'assistente indirizza l'utente a uno smartphone per continuare il flusso di collegamento dell'account.

Il divieto di creazione è consigliato se:

  • Non vuoi consentire agli utenti che hanno account non Google di creare un nuovo account utente e vuoi che si colleghino ai loro account utente esistenti nel tuo sistema di autenticazione. Ad esempio, se offri un programma fedeltà, potresti voler assicurarti che l'utente non perda i punti accumulati sul suo account esistente.

  • Devi avere il controllo completo del flusso di creazione dell'account. Ad esempio, potresti non consentire la creazione se devi mostrare i termini di servizio all'utente durante la creazione dell'account.

Implementare il collegamento "semplificato" di Accedi con Google basato su OAuth

Gli account vengono collegati con i flussi OAuth 2.0 standard di settore. Actions on Google supporta i flussi implicito e del codice di autorizzazione.

Nel flusso del codice implicito, Google apre il tuo endpoint di autorizzazione nel browser dell'utente. Dopo aver eseguito l'accesso, restituisci a Google un token di accesso di lunga durata. Questo token di accesso è ora incluso in ogni richiesta inviata dall'assistente alla tua azione.

Nel flusso del codice di autorizzazione, sono necessari due endpoint:

  • L'endpoint di autorizzazione, che è responsabile della presentazione dell'interfaccia utente di accesso agli utenti che non hanno ancora eseguito l'accesso, nonché della registrazione del consenso all'accesso richiesto sotto forma di codice di autorizzazione di breve durata.
  • L'endpoint token scambio, che è responsabile di due tipi di scambi:
    1. Scambia un codice di autorizzazione con un token di aggiornamento di lunga durata e un token di accesso di breve durata. Questo scambio avviene quando l'utente esegue il flusso di collegamento dell'account.
    2. Scambia un token di aggiornamento di lunga durata con un token di accesso di breve durata. Questa piattaforma di scambio avviene quando Google ha bisogno di un nuovo token di accesso perché quello scaduto.

Anche se il flusso del codice implicito è più facile da implementare, Google consiglia che i token di accesso emessi utilizzando il flusso implicito non scadano mai, perché l'uso della scadenza del token con il flusso implicito obbliga l'utente a collegare di nuovo il proprio account. Se per motivi di sicurezza è necessaria la scadenza del token, ti consigliamo di utilizzare il flusso del codice di autenticazione.

Configurare il progetto

Per configurare il progetto in modo da utilizzare il collegamento semplificato:

  1. Apri la console Actions e seleziona il progetto che vuoi utilizzare.
  2. Fai clic sulla scheda Sviluppa e scegli Collegamento dell'account.
  3. Attiva l'opzione accanto a Collegamento degli account.
  4. Nella sezione Creazione account, seleziona .

  5. In Tipo di collegamento, seleziona OAuth e accesso con Google e Implicito.

  6. In Informazioni cliente, segui questi passaggi:

    • Assegna un valore a ID client emesso da Actions on Google per identificare le richieste provenienti da Google.
    • Inserisci gli URL per gli endpoint di autorizzazione e scambio di token.
  7. Fai clic su Salva.

Implementa il server 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.

Gestire il collegamento automatico

Dopo che l'utente ha dato il consenso all'azione per accedere al suo profilo Google, Google invia una richiesta contenente un'asserzione firmata dell'identità dell'utente Google. L'asserzione contiene informazioni che includono l'ID, il nome e e indirizzo email. L'endpoint dello scambio di token configurato per gli handle del progetto a quella richiesta.

Se l'Account Google corrispondente è già presente nel tuo sistema di autenticazione, l'endpoint dello scambio di token restituisce un token per l'utente. Se l'Account Google non corrisponde a un utente esistente, l'endpoint di scambio di token restituisce un errore user_not_found.

La richiesta ha il seguente modulo:

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

L'endpoint di scambio di token deve essere in grado di gestire i seguenti parametri:

Parametri endpoint token
grant_type Il tipo di token che viene scambiato. Per queste richieste, ha il valore urn:ietf:params:oauth:grant-type:jwt-bearer.
intent Per queste richieste, il valore di questo parametro è "get".
assertion un token JWT (JSON Web Token) che fornisce un'asserzione firmata dei l'identità dell'utente. Il JWT contiene informazioni che includono i dati Google dell'utente ID account, nome e indirizzo email.
consent_code Facoltativo: se presente, un codice monouso che indica che la proprietà l'utente ha concesso il consenso all'azione per accedere agli ambiti specificati.
scope Facoltativo: tutti gli ambiti che hai configurato Google per richiedere agli utenti.

Quando l'endpoint di scambio di token riceve la richiesta di collegamento, dovrebbe eseguire seguenti:

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.

Controllare se l'Account Google è già presente nel sistema di autenticazione

Controlla se è vera una delle seguenti condizioni:

  • L'ID Account Google, trovato nel campo sub dell'asserzione, è nel database degli utenti.
  • L'indirizzo email nell'asserzione corrisponde a un utente nel tuo database utenti.

Se una delle condizioni è vera, l'utente si è già registrato e puoi emettere un token di accesso.

Se né l'ID Account Google né l'indirizzo email specificato nell'asserzione corrisponde a un utente presente nel tuo database, l'utente non si è ancora registrato. In questo caso, l'endpoint dello scambio di token deve rispondere con un errore HTTP 401, che specifica error=user_not_found, come nell'esempio seguente:

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

{
  "error":"user_not_found",
}
Quando Google riceve la risposta di errore 401 con un errore user_not_found, Google chiama l'endpoint di scambio di token con il valore del parametro intent impostata su create e invia un token ID contenente le informazioni del profilo dell'utente. con la richiesta.

Gestire la creazione di account tramite Accedi con Google

Quando un utente deve creare un account nel tuo servizio, Google effettua una una richiesta all'endpoint di scambio di token che specifica intent=create, come nell'esempio seguente:

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]

Il parametro assertion contiene un token JWT (JSON Web Token) che fornisce un'asserzione firmata dell'identità dell'utente Google. Il JWT contiene informazioni che include l'ID, il nome e l'indirizzo email dell'Account Google dell'utente, che puoi utilizzare per creare un nuovo account nel tuo servizio.

Per rispondere alle richieste di creazione degli account, l'endpoint di scambio di token deve eseguire l'operazione le seguenti:

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.

Convalida le informazioni dell'utente e crea un nuovo account

Controlla se è vera una delle seguenti condizioni:

  • L'ID Account Google, trovato nel campo sub dell'asserzione, è nel database degli utenti.
  • L'indirizzo email nell'asserzione corrisponde a un utente nel tuo database utenti.

Se una delle condizioni è vera, chiedi all'utente di collegare il suo account esistente a l'Account Google rispondendo alla richiesta con un errore HTTP 401, specificando error=linking_error e l'indirizzo email dell'utente come login_hint, come nell' nell'esempio seguente:

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

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

Se nessuna delle due condizioni è vera, crea un nuovo account utente utilizzando le informazioni forniti nel JWT. In genere per i nuovi account non è impostata una password. È ti consigliamo di aggiungere l'opzione Accedi con Google ad altre piattaforme per consentire agli utenti di accedere tramite Google su tutte le piattaforme della tua applicazione. In alternativa, puoi invia all'utente via email un link che avvia il flusso di recupero della password per consentirgli di impostare una password per accedere su altre piattaforme.

Al termine della creazione, invia un token di accesso e restituisce i valori in un oggetto JSON in il corpo della risposta HTTPS, come nell'esempio seguente:

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

Progettare l'interfaccia utente vocale per il flusso di autenticazione

Verifica se l'utente è verificato e avvia il flusso di collegamento degli account

  1. Apri il progetto Actions Builder nella console Actions.
  2. Crea una nuova scena per avviare il collegamento dell'account nella tua azione:
    1. Fai clic su Scene.
    2. Fai clic sull'icona Aggiungi (+) per aggiungere una nuova scena.
  3. Nella scena appena creata, fai clic sull'icona Aggiungi per Condizioni.
  4. Aggiungi una condizione che verifichi se l'utente associato alla conversazione è un utente verificato. Se il controllo non va a buon fine, l'Azione non può eseguire il collegamento dell'account durante la conversazione e deve ripiegare sull'accesso a funzionalità che non richiedono il collegamento dell'account.
    1. Nel campo Enter new expression in Condizione, inserisci la seguente logica: user.verificationStatus != "VERIFIED"
    2. In Transizione, seleziona una scena che non richiede il collegamento dell'account o una scena che è il punto di accesso alla funzionalità solo per gli ospiti.

  1. Fai clic sull'icona di aggiunta per Condizioni.
  2. Aggiungi una condizione per attivare un flusso di collegamento dell'account se l'utente non ha un'identità associata.
    1. Nel campo Enter new expression in Condizione, inserisci la seguente logica: user.verificationStatus == "VERIFIED"
    2. Nella sezione Transizione, seleziona la scena di sistema Collegamento dell'account.
    3. Fai clic su Salva.

Dopo il salvataggio, al progetto viene aggiunta una nuova scena del sistema di collegamento degli account chiamata <SceneName>_AccountLinking.

Personalizzare la scena di collegamento degli account

  1. Nella sezione Scene, seleziona la scena del sistema di collegamento degli account.
  2. Fai clic su Invia prompt e aggiungi una breve frase per descrivere all'utente perché l'azione deve accedere alla sua identità (ad esempio "Per salvare le tue preferenze").
  3. Fai clic su Salva.

  1. In Condizioni, fai clic su Se l'utente completa correttamente il collegamento degli account.
  2. Configura la modalità di avanzamento del flusso se l'utente accetta di collegare il proprio account. Ad esempio, chiama il webhook per elaborare qualsiasi logica di business personalizzata richiesta e torna alla scena di origine.
  3. Fai clic su Salva.

  1. Nella sezione Condizioni, fai clic su Se l'utente annulla o ignora il collegamento all'account.
  2. Configura la modalità di procedere del flusso se l'utente non accetta di collegare il proprio account. Ad esempio, invia un messaggio di conferma e reindirizza alle scene che forniscono funzionalità che non richiedono il collegamento dell'account.
  3. Fai clic su Salva.

  1. Nella sezione Condizioni, fai clic su Se si verifica un errore di sistema o di rete.
  2. Configura la modalità di procedere del flusso se il flusso di collegamento dell'account non può essere completato a causa di errori di sistema o di rete. Ad esempio, invia un messaggio di conferma e reindirizza alle scene che forniscono funzionalità che non richiedono il collegamento dell'account.
  3. Fai clic su Salva.

Gestire le richieste di accesso ai dati

Se la richiesta dell'assistente contiene un token di accesso, verifica prima che il token di accesso sia valido e non scaduto, poi recupera dal tuo database degli account utente l'account utente associato al token.