Jenis penautan OAuth dan Login dengan Google menambahkan Login dengan Google, bukan berbasis OAuth penautan akun. Fitur ini memberikan penautan berbasis suara yang lancar bagi pengguna Google sekaligus mengaktifkan penautan akun untuk pengguna yang telah mendaftar ke layanan Anda dengan identitas non-Google.
Jenis penautan ini dimulai dengan Login dengan Google, yang memungkinkan Anda memeriksa apakah Informasi profil Google ada dalam sistem Anda. Jika informasi pengguna tidak ditemukan di sistem Anda, alur OAuth standar akan dimulai. Pengguna juga dapat memilih untuk membuat akun baru dengan informasi profil Google mereka.
Untuk melakukan penautan akun dengan OAuth dan Login dengan Google, ikuti langkah-langkah langkah:
- Pertama, minta pengguna untuk memberikan izin agar dapat mengakses profil Google miliknya.
- Menggunakan informasi di profil mereka untuk mengidentifikasi pengguna.
- Jika Anda tidak dapat menemukan kecocokan untuk
pengguna Google di sistem autentikasi Anda,
alurnya akan berjalan, bergantung pada apakah Anda telah mengonfigurasi project Action atau tidak
di konsol Actions untuk memungkinkan pembuatan akun pengguna melalui suara atau hanya
{i>website<i} Anda.
- Jika Anda mengizinkan pembuatan akun melalui suara, validasikan ID yang diterima dari Google. Anda kemudian dapat membuat pengguna berdasarkan informasi profil yang ada dalam token ID.
- Jika Anda tidak mengizinkan pembuatan akun melalui Voice, pengguna akan ditransfer ke browser tempat mereka dapat memuat halaman otorisasi Anda dan menyelesaikan alur kreasi.
Mendukung pembuatan akun melalui suara
Jika Anda mengizinkan pembuatan akun pengguna melalui suara, Asisten akan bertanya kepada pengguna apakah mereka ingin melakukan hal berikut:
- Membuat akun baru di sistem menggunakan informasi Akun Google pengguna, atau
- Login ke sistem autentikasi Anda dengan akun lain jika akun tersebut memiliki akun non-Google yang ada.
Sebaiknya izinkan pembuatan akun melalui suara jika Anda ingin meminimalkan hambatan dari alur pembuatan akun. Pengguna hanya perlu keluar dari alur suara jika mereka ingin masuk menggunakan akun non-Google yang ada.
Larang pembuatan akun melalui suara
Jika Anda tidak mengizinkan pembuatan akun pengguna melalui suara, Asisten akan membuka URL ke situs web yang Anda berikan untuk otentikasi pengguna. Jika interaksi terjadi di perangkat yang tidak memiliki layar, Asisten mengarahkan pengguna ke ponsel untuk melanjutkan alur penautan akun.
Jangan izinkan pembuatan direkomendasikan jika:
Anda tidak ingin mengizinkan pengguna yang memiliki akun non-Google untuk membuat akun pengguna dan ingin mereka menautkan akun pengguna mereka yang ada di sistem otentikasi. Misalnya, jika Anda menawarkan program loyalitas, Anda pengguna mungkin ingin memastikan bahwa pengguna tidak kehilangan poin yang diperoleh akun yang sudah ada.
Anda harus memiliki kontrol penuh atas alur pembuatan akun. Misalnya, Anda dapat larang pembuatan jika Anda perlu menunjukkan persyaratan layanan Anda kepada pengguna selama pembuatan akun.
Terapkan penautan akun OAuth dan Login dengan Google
Akun ditautkan dengan alur OAuth 2.0 standar industri. Actions on Google mendukung alur kode implisit dan otorisasi.
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:
- 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.
- 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.
Mengonfigurasi project
Untuk mengonfigurasi project Anda agar dapat menggunakan OAuth dan akun Login dengan Google menautkan, ikuti langkah-langkah berikut:
- Buka konsol Actions dan pilih project yang ingin Anda gunakan.
- Klik tab Develop dan pilih Account linking.
- Aktifkan tombol di samping Penautan akun.
- Di bagian Pembuatan akun, pilih Ya.
Pada Linking type, pilih OAuth & Login dengan Google dan Implisit.
Di Informasi Klien, lakukan hal berikut:
- Tetapkan nilai ke Client ID yang diterbitkan oleh Actions to Google Anda untuk mengidentifikasi permintaan yang berasal dari Google.
- Masukkan URL untuk endpoint Otorisasi dan Token Exchange.
Klik Simpan.
Mengimplementasikan 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:
- 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.
- 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.
- 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 OAuth2 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:
Verify the
client_idandredirect_urivalues to prevent granting access to unintended or misconfigured client apps:- Confirm that the
client_idmatches the client ID you assigned to Google. - Confirm that the URL specified by the
redirect_uriparameter has the following form:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
- Confirm that the
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.
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.
Send an HTTP response that redirects the user's browser to the URL specified by the
redirect_uriparameter. Include all of the following parameters in the URL fragment:access_token: the access token you just generatedtoken_type: the stringbearerstate: 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.
Menangani penautan otomatis
Setelah pengguna memberikan izin kepada Action Anda untuk mengakses profil Google mereka, Google mengirimkan permintaan yang berisi pernyataan bertanda tangan tentang identitas pengguna Google. Pernyataan berisi informasi yang menyertakan ID Akun Google, nama, dan alamat email Anda. Endpoint pertukaran token yang dikonfigurasi untuk nama sebutan akun project Anda terhadap permintaan tersebut.
Jika Akun Google yang sesuai sudah ada di sistem autentikasi Anda,
endpoint pertukaran token mengembalikan
sebuah token untuk pengguna. Jika Akun Google tidak
cocok dengan pengguna yang sudah ada, endpoint pertukaran token akan menampilkan error user_not_found.
Permintaan tersebut memiliki bentuk berikut:
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
Endpoint pertukaran token Anda harus dapat menangani parameter berikut:
| Parameter endpoint token | |
|---|---|
grant_type |
Jenis token yang dipertukarkan. Untuk permintaan tersebut,
parameter memiliki nilai urn:ietf:params:oauth:grant-type:jwt-bearer. |
intent |
Untuk permintaan ini, nilai parameter ini adalah `get`. |
assertion |
JSON Web Token (JWT) yang menyediakan pernyataan bertanda tangan Google identitas pengguna. JWT berisi informasi yang menyertakan alamat ID akun, nama, dan alamat email. |
consent_code |
Opsional: Jika ada, kode sekali pakai yang menunjukkan bahwa pengguna telah memberikan izin kepada Action Anda untuk mengakses cakupan yang ditentukan. |
scope |
Opsional: Cakupan apa pun yang Anda konfigurasikan Google untuk minta dari pengguna. |
Saat menerima permintaan penautan, endpoint pertukaran token Anda harus melakukan berikut ini:
Memvalidasi dan mendekode pernyataan JWT
Anda dapat memvalidasi dan mendekode pernyataan JWT menggunakan library decoding JWT untuk bahasa Anda. Gunakan kunci publik Google (tersedia di JWK atau PEM) untuk memverifikasi tanda tangan.
Saat didekode, pernyataan JWT akan terlihat seperti contoh berikut:
{ "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" }
Selain memverifikasi tanda tangan token, verifikasi bahwa penerbit pernyataan
(kolom iss) adalah https://accounts.google.com dan bahwa audiens (kolom aud)
adalah client ID yang ditetapkan untuk Action Anda.
Periksa apakah Akun Google sudah ada dalam sistem autentikasi Anda
Periksa apakah salah satu kondisi berikut terpenuhi:
- ID Akun Google yang ada di kolom
subpernyataan berada di database pengguna Anda. - Alamat email dalam pernyataan cocok dengan pengguna di database pengguna Anda.
Jika salah satu kondisinya benar, pengguna telah mendaftar dan Anda dapat mengeluarkan token masing-masing.
Jika ID Akun Google atau alamat email yang disebutkan dalam pernyataan tidak disebutkan
cocok dengan pengguna di {i>database<i} Anda, pengguna tersebut belum mendaftar. Dalam hal ini,
endpoint pertukaran token harus membalas dengan error HTTP 401, yang menentukan error=user_not_found,
seperti dalam contoh berikut:
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{
"error":"user_not_found",
}
user_not_found,
memanggil endpoint pertukaran token dengan nilai parameter intent
ditetapkan untuk membuat dan mengirim token ID yang berisi informasi profil pengguna
dengan permintaan tersebut.
Handle account creation via Google Sign-In
When a user needs to create an account on your service, Google makes a
request to your token exchange endpoint that specifies
intent=create, as in the following example:
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]
The assertion parameter contains A JSON Web Token (JWT) that provides
a signed assertion of the Google user's identity. The JWT contains information
that includes the user's Google Account ID, name, and email address, which you can use
to create a new account on your service.
To respond to account creation requests, your token exchange endpoint must do the following:
Memvalidasi dan mendekode pernyataan JWT
Anda dapat memvalidasi dan mendekode pernyataan JWT menggunakan library decoding JWT untuk bahasa Anda. Gunakan kunci publik Google (tersedia di JWK atau PEM) untuk memverifikasi tanda tangan.
Saat didekode, pernyataan JWT akan terlihat seperti contoh berikut:
{ "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" }
Selain memverifikasi tanda tangan token, verifikasi bahwa penerbit pernyataan
(kolom iss) adalah https://accounts.google.com dan bahwa audiens (kolom aud)
adalah client ID yang ditetapkan untuk Action Anda.
Validate user information and create new account
Check whether either of the following conditions are true:
- The Google Account ID, found in the assertion's
subfield, is in your user database. - The email address in the assertion matches a user in your user database.
If either condition is true, prompt the user to link their existing account with
their Google Account by responding to the request with an HTTP 401 error, specifying
error=linking_error and the user's email address as the login_hint, as in the
following example:
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{
"error":"linking_error",
"login_hint":"foo@bar.com"
}
If neither condition is true, create a new user account using the information provided in the JWT. New accounts do not typically have a password set. It is recommended that you add Google Sign In to other platforms to enable users to log in via Google across the surfaces of your application. Alternatively, you can email the user a link that starts your password recovery flow to allow the user to set a password for signing in on other platforms.
When the creation is completed, issue an access token and return the values in a JSON object in the body of your HTTPS response, like in the following example:
{ "token_type": "Bearer", "access_token": "ACCESS_TOKEN", "expires_in": SECONDS_TO_EXPIRATION }
Memulai alur autentikasi
Menggunakan intent bantuan Login Akun untuk memulai alur otentikasi.
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(); }
Menangani permintaan akses data
Jika permintaan Asisten berisi token akses, periksa terlebih dahulu apakah token akses valid dan belum kedaluwarsa, lalu ambil dari {i>database <i}akun pengguna akun pengguna yang terkait dengan token.