Penautan akun dengan OAuth dan Login dengan Google (Dialogflow)

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.

Gambar 1: Setelah Action Anda mendapatkan akses ke profil perusahaan, Anda dapat menggunakannya untuk menemukan pengguna yang cocok di sistem otentikasi Anda.

Untuk melakukan penautan akun dengan OAuth dan Login dengan Google, ikuti langkah-langkah langkah:

1. Pertama, minta pengguna untuk memberikan izin agar dapat mengakses profil Google miliknya.
2. Menggunakan informasi di profil mereka untuk mengidentifikasi pengguna.
3. 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.

Gambar 2. Representasi visual OAuth dan Google Alur login saat informasi pengguna tidak ditemukan di sistem Anda.

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.

Catatan: Pilih salah satu opsi alur di bawah untuk mempelajari lebih lanjut cara menerapkan alur yang dipilih. Jika perlu, konten panduan akan dimuat ulang untuk disesuaikan dengan pilihan Anda.

Izinkan pembuatan akun melalui suara Larang pembuatan akun melalui suara

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.

Catatan: Jika Anda menerapkan penautan akun untuk menangani informasi keuangan, perhatikan bahwa kebijakan tambahan mungkin berlaku untuk Action Anda. Dibutuhkan waktu hingga enam minggu untuk meninjau Action dengan penautan akun untuk informasi keuangan, jadi memperhitungkan waktu tersebut saat merencanakan jadwal rilis. Untuk memudahkan peninjauan pastikan Anda mematuhi kebijakan jasa keuangan sebelum mengirimkan Action Anda untuk ditinjau.

Dalam alur kode implisit, Google membuka endpoint otorisasi Anda di browser pengguna. Setelah berhasil login, Anda akan menampilkan token akses berumur panjang ke Google. Token akses ini sekarang disertakan di setiap permintaan yang dikirim dari Asisten ke Action.

Dalam alur kode otorisasi, Anda membutuhkan dua endpoint:

• Endpoint otorisasi, yang bertanggung jawab untuk menampilkan UI login kepada pengguna yang belum login, dan merekam izin untuk akses yang diminta dalam bentuk kode otorisasi yang memiliki masa aktif singkat.
• Endpoint pertukaran token, yang bertanggung jawab atas dua jenis pertukaran:
  1. Menukarkan kode otorisasi dengan token refresh yang memiliki masa aktif lama dan token akses yang memiliki masa aktif singkat. Pertukaran ini terjadi saat pengguna melalui alur penautan akun.
  2. Menukarkan token refresh yang memiliki masa aktif lama dengan token akses yang memiliki masa aktif singkat. Pertukaran ini terjadi saat Google memerlukan token akses baru karena masa berlakunya telah berakhir.

Meskipun alur kode implisit lebih mudah diimplementasikan, Google merekomendasikan agar token akses yang dikeluarkan menggunakan alur implisit tidak pernah kedaluwarsa, karena menggunakan masa berlaku token dengan alur implisit akan memaksa pengguna untuk menautkan akunnya lagi. Jika Anda memerlukan masa berlaku token untuk alasan keamanan, Anda harus mempertimbangkan penggunaan alur kode autentikasi.

Catatan: Harap pilih alur OAuth2 yang ingin Anda implementasikan. Jika diperlukan, konten dalam panduan ini akan dimuat ulang untuk disesuaikan dengan pilihan Anda.

Kode Auth Alur implisit

Mengonfigurasi project

Untuk mengonfigurasi project Anda agar dapat menggunakan OAuth dan akun Login dengan Google menautkan, ikuti langkah-langkah berikut:

1. Buka konsol Actions dan pilih project yang ingin Anda gunakan.
2. Klik tab Develop dan pilih Account linking.
3. Aktifkan tombol di samping Penautan akun.
4. Di bagian Pembuatan akun, pilih Ya.

5. Pada Linking type, pilih OAuth & Login dengan Google dan Implisit.

   

6. 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.

7. Klik Simpan.

Mengimplementasikan server OAuth

Untuk mendukung alur implisit OAuth 2.0, layanan Anda membuat otorisasi endpoint yang tersedia melalui HTTPS. Endpoint ini bertanggung jawab untuk mengotentikasi dan mendapatkan izin dari pengguna untuk akses data. Endpoint otorisasi menampilkan UI login kepada pengguna Anda yang belum login dan merekam menyetujui akses yang diminta.

Jika Action Anda perlu memanggil salah satu API yang diotorisasi layanan Anda, Google akan menggunakan endpoint ini guna mendapatkan izin dari pengguna untuk memanggil API ini di nama Anda.

Sesi alur implisit OAuth 2.0 umum yang dimulai oleh Google memiliki alur berikut:

1. Google akan membuka endpoint otorisasi Anda di browser pengguna. Tujuan pengguna masuk jika belum masuk, dan memberikan izin kepada Google untuk mengakses data mereka dengan API Anda jika mereka belum memberikan izin.
2. Layanan Anda membuat token akses dan mengembalikannya ke Google dengan mengalihkan browser pengguna kembali ke Google dengan token akses dilampirkan pada permintaan.
3. Google memanggil API layanan Anda, dan melampirkan token akses tersebut dengan setiap permintaan. Layanan Anda memverifikasi bahwa token akses tersebut memberikan untuk mengakses API, lalu menyelesaikan panggilan API.

Menangani permintaan otorisasi

Saat Action Anda perlu melakukan penautan akun melalui alur implisit OAuth2, Google mengirim pengguna ke endpoint otorisasi Anda dengan permintaan yang mencakup parameter berikut:

Parameter endpoint otorisasi
client_id	Client ID yang Anda tetapkan ke Google.
redirect_uri	URL tempat Anda mengirim respons atas permintaan ini.
state	Nilai pembukuan yang diteruskan kembali ke Google tanpa berubah dalam URI pengalihan.
response_type	Jenis nilai yang akan ditampilkan dalam respons. Untuk OAuth 2.0 implisit alur, jenis respons selalu token.

Misalnya, jika endpoint otorisasi Anda tersedia di https://myservice.example.com/auth, permintaan akan terlihat seperti:

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

Agar endpoint otorisasi Anda dapat menangani permintaan login, lakukan langkah-langkah berikut:

1. Verifikasi nilai client_id dan redirect_uri untuk mencegah pemberian akses ke aplikasi klien yang tidak diinginkan atau salah dikonfigurasi:

   • Konfirmasi bahwa client_id cocok dengan client ID Anda ditetapkan ke Google.
   • Konfirmasi bahwa URL yang ditentukan oleh redirect_uri parameter memiliki bentuk berikut:

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

     YOUR_PROJECT_ID adalah ID yang ditemukan di halaman Setelan project dari Actions Console.

2. Periksa apakah pengguna sudah login ke layanan Anda. Jika pengguna tidak login di layanan Anda, selesaikan proses login atau pendaftaran.

3. Buat token akses yang akan digunakan Google untuk mengakses API Anda. Tujuan token akses dapat berupa nilai string apa pun, tetapi harus secara unik mewakili klien dan klien yang menjadi tujuan token, dan tidak boleh ditebak.

4. Mengirim respons HTTP yang mengalihkan browser pengguna ke URL yang ditentukan oleh parameter redirect_uri. Sertakan semua parameter berikut dalam fragmen URL:

   • access_token: token akses yang baru saja Anda buat
   • token_type: string bearer
   • state: nilai status yang tidak dimodifikasi dari aslinya minta Berikut adalah contoh URL yang dihasilkan:

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

Pengendali pengalihan OAuth 2.0 Google akan menerima token akses dan mengonfirmasi bahwa nilai state tidak berubah. Setelah Google mendapatkan token akses untuk layanan Anda, Google akan melampirkan token tersebut ke panggilan berikutnya ke Action Anda sebagai bagian dari 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:

Token endpoint parameters
grant_type	The type of token being exchanged. For these requests, this parameter has the value urn:ietf:params:oauth:grant-type:jwt-bearer.
intent	For these requests, the value of this parameter is `get`.
assertion	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.
consent_code	Optional: When present, a one-time code that indicates that the user has granted consent for your Action to access the specified scopes.
scope	Optional: Any scopes you configured Google to request from users.

When your token exchange endpoint receives the linking request, it should 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.

Catatan: Kunci tidak boleh di-hardcode. Sebagai gantinya, ikuti Penemuan koneksi OpenID protokol dan memeriksa header cache-control untuk menentukan berapa lama kunci harus di-cache.

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": "[e-mail]", // 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.

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",
}

When Google receives the 401 error response with a user_not_found error, Google calls your token exchange endpoint with the value of the intent parameter set to create and sending an ID token that contains the user's profile information with the request.

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.

Catatan: Kunci tidak boleh di-hardcode. Sebagai gantinya, ikuti Penemuan koneksi OpenID protokol dan memeriksa header cache-control untuk menentukan berapa lama kunci harus di-cache.

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": "[e-mail]", // 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 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, 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":"[e-mail]"
}

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

Peringatan: Jangan beri pengguna akun wajib menautkan prompt di awal percakapan dengan Action Anda. Sebagai gantinya, beri pengguna yang tidak diautentikasi alur tamu untuk menunjukkan cara kerja Action Anda, dan lalu hanya minta penautan akun jika perlu untuk melanjutkan. Jika pengguna meninggalkan Tindakan secara konsisten karena masalah penautan akun, Google akan tidak secara aktif mempromosikan Action, sehingga dapat menurunkan traffic pengguna Action.

Perhatikan bahwa hanya pengguna terverifikasi yang dapat melakukan penautan akun. Jika pengguna adalah tamu, penautan akun akan gagal. Pelajari cara mengidentifikasi dan menangani pengguna tamu.

Menggunakan intent bantuan Login Akun untuk memulai alur otentikasi.

Dialogflow (Node.js)

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'))
})

Dialogflow (Java)

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();
}

Actions SDK (Node.js)

const app = actionssdk({
  clientId: CLIENT_ID,
})

app.intent('Start Signin', conv => {
  conv.ask(new SignIn('To get your account details'))
})

Actions SDK (Java)

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.