Penautan Akun Google memungkinkan pemegang Akun Google terhubung dengan cepat, lancar, dan aman ke layanan Anda serta membagikan data kepada Google.
Login Akun Tertaut mengaktifkan Login Sekali Ketuk dengan Google bagi pengguna yang sudah menautkan Akun Google mereka ke layanan Anda. Tindakan ini akan meningkatkan pengalaman pengguna karena mereka dapat login dengan sekali klik, tanpa perlu memasukkan ulang nama pengguna dan sandi. Tindakan ini juga mengurangi kemungkinan pengguna membuat akun duplikat di layanan Anda.
Persyaratan
Untuk menerapkan Login Akun Tertaut, Anda harus memenuhi persyaratan berikut:
- Anda memiliki penerapan Penautan OAuth Akun Google yang mendukung alur kode otorisasi OAuth 2.0. Implementasi OAuth Anda harus menyertakan endpoint berikut:
- endpoint otorisasi untuk menangani permintaan otorisasi.
- token endpoint guna menangani permintaan akses dan token refresh.
- endpoint userinfo untuk mengambil informasi akun dasar tentang pengguna tertaut yang ditampilkan kepada pengguna selama proses Login Akun Tertaut.
- Anda memiliki aplikasi Android.
Cara kerjanya
Prasyarat : Pengguna sebelumnya telah menautkan Akun Google mereka dengan akun mereka di layanan Anda.
- Anda memilih untuk menampilkan akun tertaut selama alur Login Sekali Ketuk.
- Pengguna akan melihat perintah Login Sekali Ketuk dengan opsi untuk login ke layanan Anda dengan akun tertaut mereka.
- Jika pengguna memilih untuk melanjutkan dengan akun tertaut, Google akan mengirimkan permintaan ke endpoint token Anda untuk menyimpan kode otorisasi. Permintaan tersebut berisi token akses pengguna yang dikeluarkan oleh layanan Anda dan kode otorisasi Google.
- Anda menukar kode otorisasi Google dengan token ID Google yang berisi informasi tentang Akun Google pengguna.
- Aplikasi Anda juga menerima token ID saat alur selesai dan Anda mencocokkannya dengan ID pengguna dalam token ID yang diterima oleh server Anda untuk memasukkan pengguna ke aplikasi Anda.
Menerapkan Login Akun Tertaut di aplikasi Android
Untuk mendukung Login Akun Tertaut di aplikasi Android, ikuti petunjuk di panduan penerapan Android.
Menangani permintaan kode otorisasi dari Google
Google membuat permintaan POST ke endpoint token Anda untuk menyimpan kode otorisasi yang Anda tukarkan dengan token ID pengguna. Permintaan tersebut berisi token akses pengguna dan kode otorisasi OAuth2 yang diterbitkan Google.
Sebelum menyimpan kode otorisasi, Anda harus memverifikasi bahwa token akses yang Anda berikan kepada Google, yang diidentifikasi oleh client_id
.
Permintaan HTTP
Permintaan sampel
POST /token HTTP/1.1
Host: server.example.com
Content-Type: application/x-www-form-urlencoded
code=GOOGLE_AUTHORIZATION_CODE
&grant_type=urn:ietf:params:oauth:grant-type:reciprocal
&client_id=CLIENT_ID
&client_secret=CLIENT_SECRET
&access_token=ACCESS_TOKEN
Endpoint pertukaran token Anda harus dapat menangani parameter permintaan berikut:
Parameter endpoint token | |
---|---|
code |
Kode otorisasi Google OAuth2 yang wajib ada |
client_id |
Client ID Wajib yang Anda berikan ke Google |
client_secret |
Wajib Rahasia klien yang Anda keluarkan ke Google |
access_token |
Wajib Token akses yang Anda keluarkan ke Google. Anda akan menggunakannya untuk mendapatkan konteks pengguna |
grant_type |
Nilai Wajib HARUS ditetapkan ke urn:ietf:params:oauth:grant-type:reciprocal |
Endpoint pertukaran token Anda harus merespons permintaan POST dengan melakukan hal berikut:
- Verifikasi bahwa
access_token
telah diberikan kepada Google yang diidentifikasi olehclient_id
. - Tanggapi dengan respons HTTP 200 (OK) jika permintaan valid dan kode autentikasi berhasil ditukarkan dengan token ID Google, atau kode error HTTP jika permintaan tidak valid.
Respons HTTP
Berhasil
Kembalikan kode status HTTP 200 OK
Contoh respons sukses
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache
{}
Error
Jika ada permintaan HTTP yang tidak valid, tanggapi dengan salah satu kode error HTTP berikut:
Kode Status HTTP | Body | Deskripsi |
---|---|---|
400 | {"error": "invalid_request"} |
Permintaan tidak memiliki parameter sehingga server tidak dapat melanjutkan permintaan. Parameter ini juga dapat ditampilkan jika permintaan menyertakan parameter yang tidak didukung atau mengulangi parameter |
401 | {"error": "invalid_request"} |
Autentikasi klien gagal, misalnya jika permintaan berisi client ID atau rahasia klien yang tidak valid |
401 | {"error": "invalid_token"}
Sertakan tantangan autentikasi "WWW-Authentication: Bearer" di header respons |
Token akses partner tidak valid. |
403 | {"error": "insufficient_permission"}
Sertakan tantangan autentikasi "WWW-Authentication: Bearer" di header respons |
Token akses partner tidak berisi cakupan yang diperlukan untuk menjalankan OAuth Timbal balik |
500 | {"error": "internal_error"} |
Error server |
Respons error harus berisi kolom berikut :
Kolom respons error | |
---|---|
error |
String error Wajib |
error_description |
Deskripsi error yang dapat dibaca manusia |
error_uri |
URI yang memberikan detail error selengkapnya |
Contoh respons error 400
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"error": "invalid_request",
"error_description": "Request was missing the 'access_token' parameter."
}
Tukarkan kode otorisasi dengan token ID
Anda harus menukar kode otorisasi yang Anda terima dengan token ID Google yang berisi informasi tentang Akun Google pengguna.
Untuk menukar kode otorisasi dengan token ID Google, panggil endpoint https://oauth2.googleapis.com/token
dan tetapkan parameter berikut:
Kolom permintaan | |
---|---|
client_id |
Wajib Client ID yang diperoleh dari halaman Credentials Konsol API. Ini biasanya adalah kredensial dengan nama Aplikasi Actions on Google Baru |
client_secret |
Wajib Rahasia klien yang diperoleh dari halaman Credentials Konsol API |
code |
Wajib Kode otorisasi yang dikirim dalam permintaan awal |
grant_type |
Wajib Seperti yang ditentukan dalam spesifikasi OAuth 2.0, nilai kolom ini harus ditetapkan ke authorization_code . |
Permintaan sampel
POST /oauth2/v4/token HTTP/1.1
Host: www.googleapis.com
Content-Type: application/x-www-form-urlencoded
code=GOOGLE_AUTHORIZATION_CODE
&grant_type=authorization_code
&client_id=GOOGLE_CLIENT_ID
&client_secret=GOOGLE_CLIENT_SECRET
Google merespons permintaan ini dengan menampilkan objek JSON yang berisi token akses yang memiliki masa aktif singkat dan token refresh.
Respons berisi kolom berikut:
Kolom respons | |
---|---|
access_token |
Token akses yang dikeluarkan Google yang dikirim aplikasi Anda untuk mengizinkan permintaan Google API |
id_token |
Token ID berisi informasi Akun Google pengguna. Bagian Validasi Respons berisi detail tentang cara mendekode dan memvalidasi respons token ID |
expires_in |
Sisa masa berlaku token akses dalam hitungan detik |
refresh_token |
Token yang dapat Anda gunakan untuk mendapatkan token akses yang baru. Token refresh valid hingga pengguna mencabut akses |
scope |
Nilai kolom ini selalu ditetapkan ke openid untuk kasus penggunaan Login Akun Tertaut |
token_type |
Jenis token yang ditampilkan. Saat ini, nilai kolom ini selalu ditetapkan ke Bearer |
Contoh respons
HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
{
"access_token": "Google-access-token",
"id_token": "Google-ID-token",
"expires_in": 3599,
"token_type": "Bearer",
"scope": "openid",
"refresh_token": "Google-refresh-token"
}
POST /oauth2/v4/token HTTP/1.1
Host: www.googleapis.com
Content-Type: application/x-www-form-urlencoded
code=Google authorization code
&grant_type=authorization_code
&client_id=Google client id
&client_secret=Google client secret
Memvalidasi respons Token ID
Validasi dan dekode pernyataan JWT
Anda dapat memvalidasi dan mendekode pernyataan JWT dengan menggunakan perpustakaan decoding JWT untuk bahasa Anda . Gunakan kunci publik Google, tersedia dalam format JWK atau PEM , untuk memverifikasi tanda tangan token.
Saat didekodekan, pernyataan JWT 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 "email_verified": true, // true, if Google has verified the email address "hd": "example.com", // If present, the host domain of the user's GSuite email address // If present, a URL to user's profile picture "picture": "https://lh3.googleusercontent.com/a-/AOh14GjlTnZKHAeb94A-FmEbwZv7uJD986VOF1mJGb2YYQ", "locale": "en_US" // User's locale, from browser or phone settings }
Selain memverifikasi tanda tangan token, verifikasi bahwa penerbit pernyataan (bidang iss
) adalah https://accounts.google.com
, bahwa audiens (bidang aud
) adalah ID klien yang Anda tetapkan, dan bahwa token belum kedaluwarsa ( exp
bidang).
Dengan menggunakan bidang email
, email_verified
, dan hd
Anda dapat menentukan apakah Google menghosting dan berwenang untuk sebuah alamat email. Jika Google berwenang, pengguna saat ini diketahui sebagai pemilik akun yang sah dan Anda dapat melewati sandi atau metode tantangan lainnya. Jika tidak, metode ini dapat digunakan untuk memverifikasi akun sebelum menautkan.
Kasus di mana Google berwibawa:
-
email
memiliki akhiran@gmail.com
, ini adalah akun Gmail. -
email_verified
benar danhd
disetel, ini adalah akun G Suite.
Pengguna dapat mendaftar untuk Akun Google tanpa menggunakan Gmail atau G Suite. Jika email
tidak berisi akhiran @gmail.com
dan hd
tidak ada, Google tidak berwibawa dan sandi atau metode tantangan lainnya disarankan untuk memverifikasi pengguna. email_verfied
juga bisa benar karena Google awalnya memverifikasi pengguna saat akun Google dibuat, namun kepemilikan akun email pihak ketiga mungkin telah berubah.