Halaman ini diterjemahkan oleh Cloud Translation API.

Penautan yang Sederhana dengan OAuth dan Login dengan Google

Ringkasan

Penautan Login dengan Google yang disederhanakan OAuth menambahkan Login dengan Google di atas penautan OAuth. Hal ini memberikan pengalaman penautan yang lancar bagi pengguna Google, dan juga memungkinkan pembuatan akun, yang memungkinkan pengguna membuat akun baru di layanan Anda menggunakan Akun Google mereka.

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

Pertama, minta pengguna untuk memberi izin untuk mengakses profil Google mereka.
Gunakan informasi di profil mereka untuk memeriksa apakah akun pengguna ada.
Untuk pengguna lama, tautkan akun.
Jika Anda tidak dapat menemukan kecocokan untuk pengguna Google di sistem autentikasi, validasi token ID yang diterima dari Google. Kemudian, Anda dapat membuat pengguna berdasarkan informasi profil yang terdapat dalam token ID.

Gambar ini menunjukkan langkah-langkah bagi pengguna untuk menautkan Akun Google mereka menggunakan alur penautan yang disederhanakan. Screenshot pertama menunjukkan cara pengguna dapat memilih aplikasi Anda untuk ditautkan. Screenshot kedua memungkinkan pengguna mengonfirmasi apakah mereka sudah memiliki akun di layanan Anda atau tidak. Screenshot ketiga memungkinkan pengguna memilih Akun Google yang ingin ditautkan. Screenshot keempat menampilkan konfirmasi untuk menautkan Akun Google mereka dengan aplikasi Anda. Screenshot kelima menampilkan akun pengguna yang berhasil ditautkan di aplikasi Google.

Gambar 1. Penautan Akun di ponsel pengguna dengan Penautan yang Disederhanakan

Persyaratan untuk Penautan yang Disederhanakan

Terapkan alur penautan OAuth web dasar. Layanan Anda harus mendukung endpoint otorisasi dan pertukaran token yang mematuhi OAuth 2.0.
Endpoint pertukaran token Anda harus mendukung pernyataan JSON Web Token (JWT) dan menerapkan intent check, create, dan get.

Daftarkan Client ID Google API Anda.

Mengimplementasikan server OAuth

Endpoint pertukaran token Anda harus mendukung intent check, create, get. Di bawah ini menunjukkan langkah-langkah yang diselesaikan melalui alur penautan akun dan menunjukkan kapan intent yang berbeda dipanggil:

Apakah pengguna memiliki akun di sistem autentikasi Anda? (Pengguna memutuskan dengan memilih YA atau TIDAK)
1. YA : Apakah pengguna menggunakan email yang terkait dengan Akun Google mereka untuk login ke platform Anda? (Pengguna memutuskan dengan memilih YA atau TIDAK)
  1. YA : Apakah pengguna memiliki akun yang cocok dalam sistem autentikasi Anda? (check intent dipanggil untuk mengonfirmasi)
    1. YA : get intent dipanggil dan akun ditautkan jika intent berhasil dikembalikan.
    2. TIDAK : Buat Akun Baru? (Pengguna memutuskan dengan memilih YA atau TIDAK)
      1. YA: create intent dipanggil dan akun ditautkan jika intent pembuatan berhasil ditampilkan.
      2. TIDAK : Alur OAuth Web dipicu, pengguna diarahkan ke browser mereka, dan pengguna diberi opsi untuk menautkan dengan email yang berbeda.
  2. TIDAK : Alur OAuth Web dipicu, pengguna diarahkan ke browser mereka, dan pengguna diberi opsi untuk menautkan dengan email yang berbeda.
2. TIDAK : Apakah pengguna memiliki akun yang cocok di sistem autentikasi? (check intent dipanggil untuk mengonfirmasi)
  1. YA : get intent dipanggil dan akun ditautkan jika intent berhasil dikembalikan.
  2. TIDAK: create intent akan dipanggil dan akun akan ditautkan jika intent pembuatan berhasil ditampilkan.

Check for an existing user account (check intent)

After the user gives 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 responds with account_found=true. If the Google account doesn't match an existing user, your token exchange endpoint returns an HTTP 404 Not Found error with account_found=false.

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=check&assertion=JWT&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET

Your token exchange endpoint must be able to handle the following parameters:

Token endpoint parameters
`intent`	For these requests, the value of this parameter is `check`.
`grant_type`	The type of token being exchanged. For these requests, this parameter has the value `urn:ietf:params:oauth:grant-type:jwt-bearer`.
`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.
`client_id`	The client ID you assigned to Google.
`client_secret`	The client secret you assigned to Google.

To respond to the check intent requests, your token exchange endpoint must perform the following steps:

Validate and decode the JWT assertion.
Check if the Google account is already present in your authentication system.

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys, available in JWK or PEM formats, to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

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

In addition to verifying the token's signature, verify that the assertion's issuer (iss field) is https://accounts.google.com, that the audience (aud field) is your assigned client ID, and that the token has not expired (exp field).

Using the email, email_verified and hd fields you can determine if Google hosts and is authoritative for an email address. In cases where Google is authoritative the user is currently known to be the legitimate account owner and you may skip password or other challenges methods. Otherwise, these methods can be used to verify the account prior to linking.

Cases where Google is authoritative:

email has a @gmail.com suffix, this is a Gmail account.
email_verified is true and hd is set, this is a G Suite account.

Users may register for Google Accounts without using Gmail or G Suite. When email does not contain a @gmail.com suffix and hd is absent Google is not authoritative and password or other challenge methods are recommended to verify the user. email_verfied can also be true as Google initially verified the user when the Google account was created, however ownership of the third party email account may have since changed.

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. In that case, return a response like the following:

HTTP/1.1 200 Success
Content-Type: application/json;charset=UTF-8

{
  "account_found":"true",
}

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 needs to reply with a HTTP 404 error that specifies "account_found": "false", as in the following example:

HTTP/1.1 404 Not found
Content-Type: application/json;charset=UTF-8

{
  "account_found":"false",
}

Menangani penautan otomatis (dapatkan intent)

Setelah pengguna memberikan izin untuk mengakses profil Google mereka, Google akan mengirimkan permintaan yang berisi pernyataan bertanda tangan dari identitas pengguna Google. Pernyataan berisi informasi yang menyertakan ID, nama, dan alamat email Google pengguna. Endpoint pertukaran token yang dikonfigurasi untuk project Anda 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 sudah ada, endpoint pertukaran token akan menampilkan error linking_error dan login_hint opsional.

Permintaan memiliki format 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&scope=SCOPES&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET

Endpoint pertukaran token Anda harus dapat menangani parameter berikut:

Parameter endpoint token
`intent`	Untuk permintaan ini, nilai parameter ini adalah `get`.
`grant_type`	Jenis token yang dipertukarkan. Untuk permintaan ini, parameter ini memiliki nilai `urn:ietf:params:oauth:grant-type:jwt-bearer`.
`assertion`	Token Web JSON (JWT) yang memberikan pernyataan bertanda tangan tentang identitas pengguna Google. JWT berisi informasi yang mencakup ID, nama, dan alamat email Google milik pengguna.
`scope`	Opsional: Cakupan apa pun yang telah Anda konfigurasi oleh Google untuk diminta dari pengguna.
`client_id`	Client ID yang Anda tetapkan ke Google.
`client_secret`	Rahasia klien yang Anda tetapkan ke Google.

Untuk merespons permintaan intent get, endpoint pertukaran token Anda harus melakukan langkah-langkah berikut:

Memvalidasi dan mendekode pernyataan JWT.
Periksa apakah Akun Google sudah ada di sistem autentikasi.

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys, available in JWK or PEM formats, to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

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

Cases where Google is authoritative:

email has a @gmail.com suffix, this is a Gmail account.
email_verified is true and hd is set, this is a G Suite account.

Memeriksa apakah Akun Google sudah ada di sistem autentikasi

Periksa apakah salah satu dari kondisi berikut benar:

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

Jika akun ditemukan untuk pengguna, berikan token akses dan 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
}

Dalam beberapa kasus, penautan akun berdasarkan token ID mungkin gagal bagi pengguna. Jika dilakukan karena alasan apa pun, endpoint pertukaran token harus membalas dengan error HTTP 401 yang menentukan error=linking_error, seperti yang ditunjukkan contoh berikut:

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

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

Saat Google menerima respons error 401 dengan linking_error, Google mengirimkan pengguna ke endpoint otorisasi dengan login_hint sebagai parameter. Pengguna menyelesaikan penautan akun menggunakan alur penautan OAuth di browser mereka.

Menangani pembuatan akun melalui Login dengan Google (buat intent)

Saat pengguna perlu membuat akun di layanan Anda, Google akan membuat permintaan ke endpoint pertukaran token yang menentukan intent=create.

Permintaan memiliki format 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&assertion=JWT&client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET

Endpoint pertukaran token Anda harus dapat menangani parameter berikut:

Parameter endpoint token
`intent`	Untuk permintaan ini, nilai parameter ini adalah `create`.
`grant_type`	Jenis token yang dipertukarkan. Untuk permintaan ini, parameter ini memiliki nilai `urn:ietf:params:oauth:grant-type:jwt-bearer`.
`assertion`	Token Web JSON (JWT) yang memberikan pernyataan bertanda tangan tentang identitas pengguna Google. JWT berisi informasi yang mencakup ID, nama, dan alamat email Google milik pengguna.
`client_id`	Client ID yang Anda tetapkan ke Google.
`client_secret`	Rahasia klien yang Anda tetapkan ke Google.

JWT dalam parameter assertion berisi ID Akun Google, nama, dan alamat email pengguna, yang dapat digunakan untuk membuat akun baru di layanan Anda.

Untuk merespons permintaan intent create, endpoint pertukaran token Anda harus melakukan langkah-langkah berikut:

Memvalidasi dan mendekode pernyataan JWT.
Validasikan informasi pengguna dan buat akun baru.

Validate and decode the JWT assertion

You can validate and decode the JWT assertion by using a JWT-decoding library for your language. Use Google's public keys, available in JWK or PEM formats, to verify the token's signature.

When decoded, the JWT assertion looks like the following example:

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

Cases where Google is authoritative:

email has a @gmail.com suffix, this is a Gmail account.
email_verified is true and hd is set, this is a G Suite account.

Memvalidasi informasi pengguna dan membuat akun baru

Periksa apakah salah satu dari kondisi berikut benar:

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

Jika salah satu kondisinya benar, minta pengguna untuk menautkan akun yang ada dengan Akun Google mereka. Untuk melakukannya, respons permintaan dengan error HTTP 401 yang menentukan error=linking_error dan berikan alamat email pengguna sebagai login_hint. Berikut adalah contoh respons:

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

{
  "error":"linking_error",
  "login_hint":"foo@bar.com"
}

Jika kedua kondisi tersebut tidak benar, buat akun pengguna baru dengan informasi yang diberikan di JWT. Akun baru biasanya tidak memiliki sandi yang ditetapkan. Sebaiknya Anda menambahkan Login dengan Google ke platform lain agar pengguna dapat login dengan Google di seluruh platform aplikasi Anda. Atau, Anda dapat mengirim link kepada pengguna yang memulai alur pemulihan sandi melalui email agar pengguna dapat menetapkan sandi untuk login di platform lain.

Setelah pembuatan selesai, terbitkan token akses lalu tampilkan nilai-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
}

Mendapatkan Client ID Google API Anda

Anda akan diminta untuk memberikan Client ID Google API selama proses pendaftaran Penautan Akun.

Untuk mendapatkan Client ID API menggunakan project yang Anda buat saat menyelesaikan langkah-langkah Penautan OAuth. Caranya, selesaikan langkah-langkah berikut:

Buka halaman Credentials di konsol API Google.
Buat atau pilih project Google API.

Jika project Anda tidak memiliki Client ID untuk Jenis aplikasi Web, klik Buat kredensial > Client ID OAuth untuk membuatnya. Pastikan untuk menyertakan domain situs Anda di kotak Asal JavaScript yang sah. Saat melakukan pengujian atau pengembangan lokal, Anda harus menambahkan http://localhost dan http://localhost:<port_number> ke kolom Asal JavaScript yang sah.

Poin Penting: Tambahkan http://localhost dan http://localhost:<port_number> ke kolom Asal JavaScript yang sah untuk pengujian atau pengembangan lokal.
Catatan: ID Klien terlihat seperti contoh berikut:
```
1234567890-abc123def456.apps.googleusercontent.com
```

Memvalidasi implementasi

Anda dapat memvalidasi implementasi Anda dengan menggunakan OAuth 2.0 Playground alat.

Pada alat, lakukan langkah-langkah berikut:

Klik Konfigurasi untuk membuka jendela Configuration OAuth 2.0.
Di bidang aliran OAuth, pilih Client-side.
Di bidang OAuth endpoint, pilih Custom.
Tentukan titik akhir OAuth 2.0 dan ID klien yang Anda tetapkan ke Google di bidang yang sesuai.
Pada bagian Langkah 1, tidak memilih lingkup Google. Sebagai gantinya, biarkan bidang ini kosong atau ketik cakupan yang valid untuk server Anda (atau string arbitrer jika Anda tidak menggunakan cakupan OAuth). Setelah selesai, klik Otorisasi API.
Dalam Langkah 2 dan Langkah 3 bagian, melalui aliran OAuth 2.0 dan memverifikasi bahwa setiap langkah bekerja sebagaimana dimaksud.

Anda dapat memvalidasi implementasi Anda dengan menggunakan Akun Google Menghubungkan Demo alat.

Pada alat, lakukan langkah-langkah berikut:

Klik Sign-in dengan tombol Google.
Pilih akun yang ingin Anda tautkan.
Masukkan ID layanan.
Secara opsional, masukkan satu atau beberapa cakupan yang akan Anda minta aksesnya.
Klik Mulai Demo.
Saat diminta, konfirmasikan bahwa Anda dapat menyetujui dan menolak permintaan penautan.
Konfirmasikan bahwa Anda dialihkan ke platform Anda.