Penautan akun dengan penautan "Login dengan Google" berbasis OAuth

Jenis Penautan Login dengan Google berbasis OAuth menambahkan Login dengan Google di atas penautan akun berbasis OAuth. Hal ini akan memberikan penautan berbasis suara yang lancar bagi pengguna Google, sekaligus memungkinkan penautan akun bagi pengguna yang mendaftar ke layanan Anda dengan identitas non-Google.

Jenis penautan ini dimulai dengan Login dengan Google, yang memungkinkan Anda memeriksa apakah informasi profil Google pengguna ada di sistem Anda. Jika informasi pengguna tidak ditemukan di sistem Anda, alur OAuth standar dimulai. Pengguna juga dapat memilih untuk membuat akun baru dengan informasi profil Google-nya.

Gambar 1: Setelah Action mendapatkan akses ke profil Google pengguna, Anda dapat menggunakannya untuk menemukan kecocokan bagi pengguna di sistem autentikasi.

Untuk melakukan penautan akun dengan jenis Penautan yang disederhanakan, ikuti langkah-langkah umum berikut:

1. Pertama, minta pengguna memberikan izin untuk mengakses profil Google-nya.
2. Gunakan informasi di profil mereka untuk mengidentifikasi pengguna.
3. Jika Anda tidak dapat menemukan kecocokan untuk pengguna Google di sistem autentikasi, alur akan dilanjutkan bergantung pada apakah Anda mengonfigurasi project Action di konsol Actions untuk mengizinkan pembuatan akun pengguna melalui suara atau hanya di situs Anda.
   • Jika Anda mengizinkan pembuatan akun melalui suara, validasi token ID yang diterima dari Google. Kemudian, Anda dapat membuat pengguna berdasarkan informasi profil yang terdapat dalam token ID.
   • Jika Anda tidak mengizinkan pembuatan akun melalui suara, pengguna akan ditransfer ke browser tempat mereka dapat memuat halaman otorisasi dan menyelesaikan alur pembuatan pengguna.

Gambar 2. Representasi visual alur OAuth dan Login dengan Google saat informasi pengguna tidak ditemukan di sistem Anda.

Mendukung pembuatan akun melalui suara

Jika Anda mengizinkan pembuatan akun pengguna melalui suara, Asisten akan menanyakan kepada pengguna apakah mereka ingin melakukan hal berikut:

• Buat akun baru di sistem Anda menggunakan informasi Akun Google-nya, atau
• Login ke sistem autentikasi Anda dengan akun lain jika mereka sudah memiliki akun non-Google.

Sebaiknya izinkan pembuatan akun melalui suara jika Anda ingin meminimalkan gangguan pada alur pembuatan akun. Pengguna hanya perlu keluar dari alur suara jika ingin login menggunakan akun non-Google yang sudah 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 autentikasi pengguna. Jika interaksi terjadi di perangkat yang tidak memiliki layar, Asisten akan mengarahkan pengguna ke ponsel untuk melanjutkan alur penautan akun.

Sebaiknya jangan izinkan pembuatan jika:

• Anda tidak ingin mengizinkan pengguna yang memiliki akun non-Google membuat akun pengguna baru dan ingin mereka menautkan ke akun pengguna yang ada dalam sistem autentikasi Anda. Misalnya, jika Anda menawarkan program loyalitas, Anda mungkin ingin memastikan bahwa pengguna tidak kehilangan poin yang dikumpulkan di akunnya yang sudah ada.

• Anda harus memiliki kontrol penuh atas alur pembuatan akun. Misalnya, Anda dapat melarang pembuatan jika Anda perlu menampilkan persyaratan layanan kepada pengguna selama pembuatan akun.

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

Izinkan pembuatan akun melalui suara Larang pembuatan akun melalui suara

Menerapkan penautan "Menyederhanakan" Login dengan Google berbasis OAuth

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, perlu diperhatikan bahwa kebijakan tambahan mungkin berlaku untuk Action Anda. Kami membutuhkan waktu hingga enam minggu untuk meninjau Action dengan penautan akun untuk mendapatkan informasi keuangan, jadi perhitungkan waktu tersebut saat merencanakan jadwal rilis Anda. Untuk memudahkan proses peninjauan, pastikan Anda mematuhi kebijakan jasa keuangan sebelum mengirimkan Action 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: Pilih alur OAuth 2.0 yang ingin Anda terapkan. 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 menggunakan Penautan yang disederhanakan, 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. Di Jenis penautan, pilih Login dengan Google & OAuth lalu Implisit.

   

6. Di Informasi Klien, lakukan hal berikut:

   • Tetapkan nilai ke Client ID yang dikeluarkan oleh Actions Anda ke Google untuk mengidentifikasi permintaan yang berasal dari Google.
   • Masukkan URL untuk endpoint Otorisasi dan Pertukaran Token.

7. Klik Simpan.

Menerapkan server OAuth

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

Jika Action Anda perlu memanggil salah satu API yang diberi otorisasi oleh layanan Anda, Google akan menggunakan endpoint ini untuk mendapatkan izin dari pengguna Anda untuk memanggil API ini atas nama mereka.

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

1. Google akan membuka endpoint otorisasi Anda di browser pengguna. Pengguna akan login jika belum, dan memberi Google izin untuk mengakses datanya 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 yang disertakan ke permintaan.
3. Google memanggil API layanan Anda, dan melampirkan token akses bersama setiap permintaan. Layanan Anda memverifikasi bahwa token akses memberikan otorisasi kepada Google untuk mengakses API, lalu menyelesaikan panggilan API.

Menangani permintaan otorisasi

Saat Action Anda perlu melakukan penautan akun melalui alur implisit OAuth 2.0, Google akan mengirimkan pengguna ke endpoint otorisasi Anda dengan permintaan yang menyertakan parameter berikut:

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

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

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:

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

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

     YOUR_PROJECT_ID adalah ID yang ditemukan di halaman Setelan project Konsol Actions.

2. Periksa apakah pengguna login ke layanan Anda. Jika pengguna belum login, selesaikan alur login atau pendaftaran layanan Anda.

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

4. Kirim 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 permintaan asli. 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.

Menangani penautan otomatis

Setelah pengguna memberikan izin kepada Action Anda untuk mengakses profil Google mereka, Google akan mengirimkan permintaan yang berisi pernyataan identitas pengguna Google yang ditandatangani. Pernyataan berisi informasi yang menyertakan ID Akun Google, nama, dan alamat email pengguna. Endpoint pertukaran token yang dikonfigurasi untuk project Anda akan menangani permintaan tersebut.

Jika Akun Google yang sesuai sudah ada di sistem autentikasi, endpoint pertukaran token akan menampilkan token untuk pengguna. Jika Akun Google tidak cocok dengan pengguna yang ada, endpoint pertukaran token Anda 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 ini memiliki nilai urn:ietf:params:oauth:grant-type:jwt-bearer.
intent	Untuk permintaan tersebut, nilai parameter ini adalah `get`.
assertion	Token Web JSON (JWT) yang memberikan pernyataan yang ditandatangani atas identitas pengguna Google. JWT berisi informasi yang menyertakan ID Akun Google, nama, dan alamat email pengguna.
consent_code	Opsional: Jika ada, kode sekali pakai yang menunjukkan bahwa pengguna telah memberikan izin agar Action Anda dapat mengakses cakupan yang ditentukan.
scope	Opsional: Cakupan apa pun yang Anda konfigurasikan untuk diminta oleh Google dari pengguna.

Saat menerima permintaan penautan, endpoint pertukaran token Anda harus melakukan hal berikut:

Memvalidasi dan mendekode pernyataan JWT

Anda dapat memvalidasi dan mendekode pernyataan JWT menggunakan library decoding JWT untuk bahasa Anda. Gunakan kunci publik Google (tersedia dalam format JWK atau PEM) untuk memverifikasi tanda tangan token.

Catatan: Kunci tidak boleh di-hardcode. Sebagai gantinya, ikuti protokol penemuan OpenID connect dan periksa 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, pastikan penerbit pernyataan (kolom iss) adalah https://accounts.google.com dan audiens (kolom aud) adalah client ID yang ditetapkan untuk Action Anda.

Memeriksa apakah Akun Google sudah ada di sistem autentikasi

Periksa apakah salah satu kondisi berikut terpenuhi:

• ID Akun Google yang dapat ditemukan di kolom sub pernyataan ada di database pengguna Anda.
• Alamat email dalam pernyataan cocok dengan pengguna dalam database pengguna Anda.

Jika salah satu kondisi tersebut terpenuhi, berarti pengguna telah mendaftar dan Anda dapat menerbitkan token akses.

Jika ID Akun Google atau alamat email yang ditentukan dalam pernyataan tidak cocok dengan pengguna dalam database Anda, artinya pengguna belum mendaftar. Dalam hal ini, endpoint pertukaran token Anda 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",
}

Saat Google menerima respons error 401 dengan error user_not_found, Google akan memanggil endpoint pertukaran token Anda dengan nilai parameter intent yang ditetapkan untuk membuat dan mengirimkan token ID yang berisi informasi profil pengguna bersama permintaan tersebut.

Menangani pembuatan akun melalui Login dengan Google

Jika pengguna perlu membuat akun di layanan Anda, Google akan membuat permintaan ke endpoint pertukaran token Anda yang menentukan intent=create, seperti dalam contoh berikut:

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]

Parameter assertion berisi Token Web JSON (JWT) yang memberikan pernyataan yang ditandatangani tentang identitas pengguna Google. JWT berisi informasi yang mencakup ID Akun Google, nama, dan alamat email pengguna, yang dapat digunakan untuk membuat akun baru di layanan Anda.

Untuk merespons permintaan pembuatan akun, endpoint pertukaran token Anda harus melakukan hal berikut:

Memvalidasi dan mendekode pernyataan JWT

Anda dapat memvalidasi dan mendekode pernyataan JWT menggunakan library decoding JWT untuk bahasa Anda. Gunakan kunci publik Google (tersedia dalam format JWK atau PEM) untuk memverifikasi tanda tangan token.

Catatan: Kunci tidak boleh di-hardcode. Sebagai gantinya, ikuti protokol penemuan OpenID connect dan periksa 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, pastikan penerbit pernyataan (kolom iss) adalah https://accounts.google.com dan audiens (kolom aud) adalah client ID yang ditetapkan untuk Action Anda.

Validasi informasi pengguna dan buat akun baru

Periksa apakah salah satu kondisi berikut terpenuhi:

• ID Akun Google yang dapat ditemukan di kolom sub pernyataan ada di database pengguna Anda.
• Alamat email dalam pernyataan cocok dengan pengguna dalam database pengguna Anda.

Jika salah satu kondisi tersebut terpenuhi, minta pengguna untuk menautkan akun yang ada dengan Akun Google mereka dengan merespons permintaan menggunakan error HTTP 401, dengan menentukan error=linking_error dan alamat email pengguna sebagai login_hint, seperti dalam contoh berikut:

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

{
  "error":"linking_error",
  "login_hint":"[e-mail]"
}

Jika tidak ada kondisi yang benar, buat akun pengguna baru menggunakan informasi yang diberikan di JWT. Akun baru biasanya belum menetapkan sandi. Sebaiknya tambahkan Login dengan Google ke platform lain untuk memungkinkan pengguna login melalui Google di seluruh platform aplikasi Anda. Atau, Anda dapat mengirimkan link melalui email kepada pengguna yang memulai alur pemulihan sandi agar pengguna dapat menyetel sandi untuk login di platform lain.

Setelah pembuatan selesai, keluarkan token akses , lalu tampilkan nilai dalam objek JSON dalam isi respons HTTPS Anda, seperti dalam contoh berikut:

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

Mendesain antarmuka pengguna suara untuk alur autentikasi

Peringatan: Jangan beri pengguna permintaan penautan akun wajib di awal percakapan dengan Action Anda. Sebagai gantinya, berikan alur tamu kepada pengguna yang tidak diautentikasi untuk menunjukkan cara kerja Action Anda, lalu minta penautan akun hanya jika diperlukan untuk melanjutkan. Jika pengguna keluar dari Action secara konsisten karena masalah penautan akun, Google tidak akan secara aktif mempromosikan Action, sehingga dapat menurunkan traffic pengguna Action tersebut.

Catatan: Anda harus menggunakan Actions Builder untuk membuat Action yang menerapkan penautan akun.

Periksa apakah pengguna telah diverifikasi dan mulai alur penautan akun

1. Buka project Action Builder Anda di Konsol Actions.
2. Buat scene baru untuk memulai penautan akun di Action Anda:
   1. Klik Scene.
   2. Klik ikon add (+) untuk menambahkan adegan baru.
3. Pada scene yang baru dibuat, klik ikon tambahkan untuk Kondisi.
4. Tambahkan kondisi yang memeriksa apakah pengguna yang terkait dengan percakapan adalah pengguna terverifikasi. Jika pemeriksaan gagal, Action Anda tidak dapat melakukan penautan akun selama percakapan, dan harus kembali menyediakan akses ke fungsi yang tidak memerlukan penautan akun.
   1. Di kolom Enter new expression pada bagian Kondisi, masukkan logika berikut: user.verificationStatus != "VERIFIED"
   2. Di bagian Transition, pilih scene yang tidak memerlukan penautan akun atau scene yang merupakan titik entri ke fungsi khusus tamu.

1. Klik ikon tambahkan untuk Kondisi.
2. Tambahkan kondisi untuk memicu alur penautan akun jika pengguna tidak memiliki identitas terkait.
   1. Di kolom Enter new expression pada bagian Kondisi, masukkan logika berikut: user.verificationStatus == "VERIFIED"
   2. Di bagian Transisi, pilih scene sistem Penautan Akun.
   3. Klik Simpan.

Setelah disimpan, scene sistem penautan akun baru yang disebut <SceneName>_AccountLinking akan ditambahkan ke project Anda.

Menyesuaikan adegan penautan akun

1. Di bagian Scene, pilih scene sistem penautan akun.
2. Klik Kirim perintah dan tambahkan kalimat singkat untuk menjelaskan kepada pengguna alasan Action perlu mengakses identitas mereka (misalnya, "Untuk menyimpan preferensi Anda").
3. Klik Simpan.

1. Di bagian Kondisi, klik Jika pengguna berhasil menyelesaikan penautan akun.
2. Konfigurasi cara alur berjalan jika pengguna setuju untuk menautkan akun mereka. Misalnya, panggil webhook untuk memproses logika bisnis kustom yang diperlukan dan lakukan transisi kembali ke scene asal.
3. Klik Simpan.

1. Di bagian Kondisi, klik Jika pengguna membatalkan atau menolak penautan akun.
2. Konfigurasikan cara alur akan dilanjutkan jika pengguna tidak setuju untuk menautkan akunnya. Misalnya, kirim pesan konfirmasi dan alihkan ke scene yang menyediakan fungsi yang tidak memerlukan penautan akun.
3. Klik Simpan.

1. Di bagian Kondisi, klik Jika terjadi error sistem atau jaringan.
2. Konfigurasikan cara alur akan dilanjutkan jika alur penautan akun tidak dapat diselesaikan karena error sistem atau jaringan. Misalnya, kirim pesan konfirmasi dan alihkan ke scene yang menyediakan fungsi yang tidak memerlukan penautan akun.
3. Klik Simpan.

Menangani permintaan akses data

Jika permintaan Asisten berisi token akses, periksa terlebih dahulu apakah token akses valid dan belum habis masa berlakunya, lalu ambil akun pengguna yang terkait dengan token tersebut dari database akun pengguna.