Il tipo di collegamento OAuth e Accedi con Google aggiunge Accedi con Google oltre al collegamento dell'account basato su OAuth. In questo modo, gli utenti Google possono effettuare il collegamento tramite voce senza interruzioni e allo stesso tempo abilitare il collegamento degli account per gli utenti che si sono registrati al tuo servizio con un'identità non Google.
Questo tipo di collegamento inizia con Accedi con Google, che consente di verificare se le informazioni del profilo Google dell'utente sono presenti nel sistema. Se le informazioni dell'utente non vengono trovate nel sistema, viene avviato un flusso OAuth standard. L'utente può anche scegliere di creare un nuovo account con le informazioni del proprio profilo Google.
Per eseguire il collegamento dell'account con OAuth e Accedi con Google, segui questi passaggi generali:
- Innanzitutto, chiedi all'utente di dare il consenso ad accedere al proprio profilo Google.
- Utilizza le informazioni del profilo per identificare l'utente.
- 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 progetto Actions nella console di Actions per consentire la creazione di account utente tramite comandi vocali 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 comandi vocali, l'utente viene trasferito a un browser in cui può caricare la pagina di autorizzazione e completare il flusso di creazione dell'utente.
Supporta la creazione di account tramite comandi vocali
Se consenti la creazione di account utente tramite comandi vocali, l'assistente chiede all'utente se vuole effettuare le seguenti operazioni:
- Creare un nuovo account sul tuo sistema utilizzando i dati del suo account Google oppure
- Accedi al tuo sistema di autenticazione con un altro account se dispongono già di un account non Google.
Per ridurre al minimo l'attrito del flusso di creazione degli account, ti consigliamo di consentire la creazione di account tramite comandi vocali. L'utente deve abbandonare il 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 comandi vocali, l'assistente apre l'URL del sito web che hai fornito per l'autenticazione utente. Se l'interazione avviene su un dispositivo privo di schermo, l'assistente indirizza l'utente a un telefono per continuare la procedura di collegamento dell'account.
Ti consigliamo di non consentire la creazione se:
Non vuoi consentire agli utenti con 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à, ti consigliamo di 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 consentire la creazione se devi mostrare i tuoi Termini di servizio all'utente durante la creazione dell'account.
Implementare OAuth e il collegamento all'account Accedi con Google
Gli account sono collegati a 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:
- 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.
- 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.
Configura il progetto
Per configurare il tuo progetto per l'utilizzo del collegamento di account OAuth e Accedi con Google, segui questi passaggi:
- Apri la console di Actions e seleziona il progetto che vuoi utilizzare.
- Fai clic sulla scheda Sviluppo e scegli Collegamento dell'account.
- Attiva l'opzione Collegamento dell'account.
- Nella sezione Creazione account, seleziona Sì.
In Tipo di collegamento, seleziona Accesso OAuth e Google e Implicito.
In Informazioni sul cliente, procedi nel seguente modo:
- Assegna un valore al Client-ID emesso dalle tue Azioni a Google per identificare le richieste provenienti da Google.
- Inserisci gli URL per gli endpoint di autorizzazione e di scambio dei token.
Fai clic su Salva.
Implementare il server OAuth
Per supportare il flusso implicito OAuth 2.0, il servizio rende disponibile un endpoint di autorizzazione tramite HTTPS. Questo endpoint è responsabile dell'autenticazione e dell'ottenimento del consenso degli utenti per l'accesso ai dati. L'endpoint di autorizzazione presenta un'UI di accesso agli utenti che non hanno ancora effettuato l'accesso e registra il consenso all'accesso richiesto.
Quando l'Azione deve chiamare una delle API autorizzate del tuo servizio, Google utilizza questo endpoint per ottenere l'autorizzazione dagli utenti a chiamare queste API per loro conto.
Una tipica sessione di flusso implicito OAuth 2.0 avviata da Google prevede il seguente flusso:
- Google apre il tuo endpoint di autorizzazione nel browser dell'utente. L'utente esegue l'accesso se non ha già effettuato l'accesso e concede a Google l'autorizzazione ad accedere ai suoi dati con la tua API, se non l'ha già fatto.
- Il servizio crea un token di accesso e lo restituisce a Google reindirizzando il browser dell'utente a Google con il token di accesso allegato alla richiesta.
- Google chiama le API del tuo servizio e allega il token di accesso a ogni richiesta. Il servizio verifica che il token di accesso conceda a Google l'autorizzazione ad accedere all'API, quindi completa la chiamata API.
Gestire le richieste di autorizzazione
Quando l'Azione deve eseguire il collegamento dell'account tramite un flusso OAuth2 implicito, Google invia l'utente all'endpoint di autorizzazione con una richiesta che include i seguenti parametri:
| Parametri endpoint di autorizzazione | |
|---|---|
client_id |
L'ID client che hai assegnato a Google. |
redirect_uri |
L'URL a cui invii la risposta a questa richiesta. |
state |
Un valore contabile che viene restituito a Google e invariato nell'URI di reindirizzamento. |
response_type |
Il tipo di valore da restituire nella risposta. Per il flusso implicito OAuth 2.0, il tipo di risposta è sempre token. |
Ad esempio, se il tuo endpoint di autorizzazione è disponibile all'indirizzo https://myservice.example.com/auth,
una richiesta potrebbe essere simile a:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token
Affinché il tuo endpoint di autorizzazione possa gestire le richieste di accesso:
Verifica i valori
client_ideredirect_uriper impedire di concedere l'accesso ad app client indesiderate o configurate in modo errato:- Verifica che
client_idcorrisponda all'ID client assegnato a Google. - Verifica che l'URL specificato dal parametro
redirect_uriabbia il formato seguente:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
YOUR_PROJECT_ID è l'ID che si trova nella pagina Impostazioni progetto di Actions Console.
- Verifica che
Controlla se l'utente ha eseguito l'accesso al servizio. Se l'utente non ha eseguito l'accesso, completa il flusso di accesso o registrazione al servizio.
Genera un token di accesso che Google utilizzerà per accedere alla tua API. Il token di accesso può essere qualsiasi valore stringa, ma deve rappresentare in modo univoco l'utente e il client a cui si riferisce il token e non deve essere intuibile.
Invia una risposta HTTP che reindirizza il browser dell'utente all'URL specificato dal parametro
redirect_uri. Includi tutti i seguenti parametri nel frammento di URL:access_token: il token di accesso appena generatotoken_type: la stringabearerstate: il valore dello stato non modificato della richiesta originale Di seguito è riportato un esempio dell'URL risultante:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
Il gestore del reindirizzamento OAuth 2.0 di Google riceverà il token di accesso e confermerà che il valore state non è cambiato. Dopo che Google avrà ottenuto un token di accesso per il tuo servizio, lo associa alle chiamate successive all'Azione nell'ambito di AppRequest.
Gestire il collegamento automatico
Dopo che l'utente ha concesso il consenso all'Azione per accedere al proprio profilo Google, Google invia una richiesta contenente un'affermazione firmata dell'identità dell'utente Google. L'asserzione contiene informazioni che includono l'ID, il nome e l'indirizzo email dell'Account Google dell'utente. L'endpoint di scambio di token configurato per il progetto gestisce la richiesta.
Se l'Account Google corrispondente è già presente nel tuo sistema di autenticazione, l'endpoint di 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 formato:
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, questo parametro 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 dell'identità dell'utente Google. Il JWT contiene informazioni che includono l'ID, il nome e l'indirizzo email dell'Account Google dell'utente. |
consent_code |
Facoltativo: se presente, un codice monouso che indica che l'utente ha concesso il consenso all'Azione per accedere agli ambiti specificati. |
scope |
(Facoltativo) Qualsiasi ambito che Google deve richiedere agli utenti. |
Quando l'endpoint di scambio di token riceve la richiesta di collegamento, dovrebbe:
Convalida e decodifica l'asserzione JWT
Puoi convalidare e decodificare l'asserzione JWT utilizzando una libreria di decodifica JWT per la tua lingua. Utilizza le chiavi pubbliche di Google (disponibili in formato JWK o PEM) per verificare la firma del token.
Una volta decodificata, l'asserzione JWT è simile al seguente esempio:
{
"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"
}
Oltre a verificare la firma del token, verifica che l'emittente dell'asserzione (campo iss) sia https://accounts.google.com e che il segmento di pubblico (campo aud) sia l'ID client assegnato all'Azione.
Verificare se l'Account Google è già presente nel sistema di autenticazione
Controlla se una delle seguenti condizioni è vera:
- L'ID Account Google, indicato nel campo
subdell'asserzione, si trova nel tuo database utenti. - L'indirizzo e-mail 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 dell'Account Google né l'indirizzo email specificato nell'asserzione corrispondono a un utente nel tuo database, significa che l'utente non si è ancora registrato. In questo caso, l'endpoint di 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, chiama l'endpoint di scambio di token con il valore del parametro intent impostato 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 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 includono 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 di account, l'endpoint di scambio di token deve:
Convalida e decodifica l'asserzione JWT
Puoi convalidare e decodificare l'asserzione JWT utilizzando una libreria di decodifica JWT per la tua lingua. Utilizza le chiavi pubbliche di Google (disponibili in formato JWK o PEM) per verificare la firma del token.
Una volta decodificata, l'asserzione JWT è simile al seguente esempio:
{
"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"
}
Oltre a verificare la firma del token, verifica che l'emittente dell'asserzione (campo iss) sia https://accounts.google.com e che il segmento di pubblico (campo aud) sia l'ID client assegnato all'Azione.
Convalida le informazioni degli utenti e crea un nuovo account
Controlla se una delle seguenti condizioni è vera:
- L'ID Account Google, indicato nel campo
subdell'asserzione, si trova nel tuo database utenti. - L'indirizzo e-mail nell'asserzione corrisponde a un utente nel tuo database utenti.
Se una delle condizioni è vera, chiedi all'utente di collegare l'account esistente al proprio 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'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 fornite nel JWT. In genere, per i nuovi account non è impostata una password. Ti consigliamo di aggiungere Accedi con Google ad altre piattaforme per consentire agli utenti di accedere tramite Google su tutte le piattaforme della tua applicazione. In alternativa, puoi inviare all'utente un'email con un link che avvia la procedura di recupero della password per permettergli di impostare una password per l'accesso su altre piattaforme.
Al termine della creazione, emetti un token di accesso, e restituisci i valori in un oggetto JSON nel corpo della risposta HTTPS, come nell'esempio seguente:
{
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}
Avvia il flusso di autenticazione
Utilizza l'intent helper per l'accesso all'account per avviare il flusso di autenticazione.
const app = dialogflow({
// REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
clientId: CLIENT_ID,
})
// Intent that starts the account linking flow.
app.intent('Start Signin', conv => {
conv.ask(new SignIn('To get your account details'))
})
private String clientId = "<your_client_id>";
@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
ResponseBuilder rb = getResponseBuilder(request);
return rb.add(new SignIn().setContext("To get your account details")).build();
}
const app = actionssdk({
clientId: CLIENT_ID,
})
app.intent('Start Signin', conv => {
conv.ask(new SignIn('To get your account details'))
})
private String clientId = "<your_client_id>";
@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
ResponseBuilder rb = getResponseBuilder(request);
return rb.add(new SignIn().setContext("To get your account details")).build();
}
Gestire le richieste di accesso ai dati
Se la richiesta dell'assistente contiene un token di accesso, verifica che il token di accesso sia valido e che non sia scaduto, quindi recupera dal database degli account utente l'account utente associato al token.