Penautan Akun Google dengan OAuth

Akun ditautkan menggunakan standar industri OAuth 2.0 implisit dan aliran kode otorisasi . Layanan Anda harus mendukung otorisasi yang sesuai dengan OAuth 2.0 dan titik akhir pertukaran token .

Dalam alur implisit , Google membuka titik akhir otorisasi Anda di browser pengguna. Setelah berhasil masuk, Anda mengembalikan token akses berumur panjang ke Google. Token akses ini sekarang disertakan dalam setiap permintaan yang dikirim dari Google.

Dalam alur kode otorisasi , Anda memerlukan dua titik akhir:

  • Titik akhir otorisasi , yang menampilkan UI masuk kepada pengguna Anda yang belum masuk. Titik akhir otorisasi juga membuat kode otorisasi berumur pendek untuk mencatat persetujuan pengguna atas akses yang diminta.

  • Titik akhir pertukaran token , yang bertanggung jawab atas dua jenis pertukaran:

    1. Menukar kode otorisasi untuk token penyegaran berumur panjang dan token akses berumur pendek. Pertukaran ini terjadi saat pengguna melewati alur penautan akun.
    2. Menukar token penyegaran berumur panjang dengan token akses berumur pendek. Pertukaran ini terjadi ketika Google membutuhkan token akses baru karena sudah kedaluwarsa.

Pilih aliran OAuth 2.0

Meskipun aliran implisit lebih sederhana untuk diterapkan, Google merekomendasikan agar token akses yang dikeluarkan oleh aliran implisit tidak pernah kedaluwarsa. Ini karena pengguna dipaksa untuk menautkan akunnya lagi setelah token kedaluwarsa dengan aliran implisit. Jika Anda memerlukan token kedaluwarsa karena alasan keamanan, kami sangat menyarankan agar Anda menggunakan alur kode otorisasi sebagai gantinya.

Pedoman desain

Bagian ini menjelaskan persyaratan desain dan rekomendasi untuk layar pengguna yang Anda hosting untuk alur penautan OAuth. Setelah dipanggil oleh aplikasi Google, platform Anda menampilkan halaman masuk ke Google dan layar persetujuan penautan akun kepada pengguna. Pengguna diarahkan kembali ke aplikasi Google setelah memberikan persetujuan mereka untuk menautkan akun.

Gambar ini menunjukkan langkah-langkah bagi pengguna untuk menautkan akun Google mereka ke sistem otentikasi Anda. Tangkapan layar pertama menunjukkan penautan yang dimulai pengguna dari platform Anda. Gambar kedua menunjukkan pengguna masuk ke Google, sedangkan gambar ketiga menunjukkan persetujuan dan konfirmasi pengguna untuk menautkan akun Google mereka dengan aplikasi Anda. Tangkapan layar terakhir menunjukkan akun pengguna yang berhasil ditautkan di aplikasi Google.
Gambar 1. Pengguna yang menautkan akun masuk ke Google dan layar persetujuan.

Persyaratan

  1. Anda harus menyampaikan bahwa akun pengguna akan ditautkan ke Google, bukan produk Google tertentu seperti Google Home atau Asisten Google.

Rekomendasi

Kami menyarankan Anda melakukan hal berikut:

  1. Tampilkan Kebijakan Privasi Google. Sertakan tautan ke Kebijakan Privasi Google di layar persetujuan.

  2. Data untuk dibagikan. Gunakan bahasa yang jelas dan ringkas untuk memberi tahu pengguna data apa yang dibutuhkan Google mereka dan mengapa.

  3. Ajakan bertindak yang jelas. Nyatakan ajakan bertindak yang jelas di layar persetujuan Anda, seperti "Setuju dan tautkan". Ini karena pengguna perlu memahami data apa yang mereka butuhkan untuk dibagikan dengan Google untuk menautkan akun mereka.

  4. Kemampuan untuk membatalkan. Sediakan cara bagi pengguna untuk kembali atau membatalkan, jika mereka memilih untuk tidak menautkan.

  5. Hapus proses masuk. Pastikan pengguna memiliki metode yang jelas untuk masuk ke akun Google mereka, seperti bidang untuk nama pengguna dan sandi atau Masuk dengan Google .

  6. Kemampuan untuk membatalkan tautan. Tawarkan mekanisme bagi pengguna untuk membatalkan tautan, seperti URL ke pengaturan akun mereka di platform Anda. Atau, Anda dapat menyertakan tautan ke Akun Google tempat pengguna dapat mengelola akun tertaut mereka.

  7. Kemampuan untuk mengubah akun pengguna. Sarankan metode bagi pengguna untuk mengalihkan akun mereka. Ini sangat bermanfaat jika pengguna cenderung memiliki banyak akun.

    • Jika pengguna harus menutup layar persetujuan untuk beralih akun, kirimkan kesalahan yang dapat dipulihkan ke Google sehingga pengguna dapat masuk ke akun yang diinginkan dengan penautan OAuth dan alur implisit .
  8. Sertakan logo Anda. Tampilkan logo perusahaan Anda di layar persetujuan. Gunakan pedoman gaya Anda untuk menempatkan logo Anda. Jika Anda juga ingin menampilkan logo Google, lihat Logo dan merek dagang .

Create the project

To create your project to use account linking:

  1. Go to the Google API Console.
  2. Klik Buat proyek .
  3. Masukkan nama atau terima saran yang dihasilkan.
  4. Konfirmasikan atau edit bidang yang tersisa.
  5. Klik Buat .

Untuk melihat ID proyek Anda:

  1. Go to the Google API Console.
  2. Temukan proyek Anda di tabel di halaman arahan. ID proyek muncul di kolom ID .

The Google Account Linking process includes a consent screen which tells users the application requesting access to their data, what kind of data they are asking for and the terms that apply. You will need to configure your OAuth consent screen before generating a Google API client ID.

  1. Open the OAuth consent screen page of the Google APIs console.
  2. If prompted, select the project you just created.
  3. On the "OAuth consent screen" page, fill out the form and click the “Save” button.

    Application name: The name of the application asking for consent. The name should accurately reflect your application and be consistent with the application name users see elsewhere. The application name will be shown on the Account Linking consent screen.

    Application logo: An image on the consent screen that will help users recognize your app. The logo is shown on Account linking consent screen and on account settings

    Support email: For users to contact you with questions about their consent.

    Scopes for Google APIs: Scopes allow your application to access your user's private Google data. For the Google Account Linking use case, default scope (email, profile, openid) is sufficient, you don’t need to add any sensitive scopes. It is generally a best practice to request scopes incrementally, at the time access is required, rather than up front. Learn more.

    Authorized domains: To protect you and your users, Google only allows applications that authenticate using OAuth to use Authorized Domains. Your applications' links must be hosted on Authorized Domains. Learn more.

    Application Homepage link: Home page for your application. Must be hosted on an Authorized Domain.

    Application Privacy Policy link: Shown on Google Acount Linking consent screen. Must be hosted on an Authorized Domain.

    Application Terms of Service link (Optional): Must be hosted on an Authorized Domain.

    Figure 1. Google Account Linking Consent Screen for a fictitious Application, Tunery

  4. Check "Verification Status", if your application needs verification then click the "Submit For Verification" button to submit your application for verification. Refer to OAuth verification requirements for details.

Terapkan server OAuth Anda

Untuk mendukung aliran implisit OAuth 2.0, layanan Anda menyediakan titik akhir otorisasi melalui HTTPS. Titik akhir ini bertanggung jawab untuk otentikasi dan mendapatkan persetujuan dari pengguna untuk akses data. Titik akhir otorisasi menampilkan UI masuk kepada pengguna Anda yang belum masuk dan mencatat persetujuan untuk akses yang diminta.

Saat aplikasi Google perlu memanggil salah satu API resmi layanan Anda, Google menggunakan titik akhir ini untuk mendapatkan izin dari pengguna Anda untuk memanggil API ini atas nama mereka.

Sesi aliran implisit OAuth 2.0 khas yang dimulai oleh Google memiliki aliran berikut:

  1. Google membuka titik akhir otorisasi Anda di browser pengguna. Pengguna masuk, jika belum masuk, dan memberi Google izin untuk mengakses data mereka dengan API Anda, jika mereka belum memberikan izin.
  2. Layanan Anda membuat token akses dan mengembalikannya ke Google. Untuk melakukannya, alihkan kembali browser pengguna ke Google dengan token akses yang dilampirkan ke permintaan.
  3. Google memanggil API layanan Anda dan melampirkan token akses dengan setiap permintaan. Layanan Anda memverifikasi bahwa token akses memberi Google otorisasi untuk mengakses API dan kemudian menyelesaikan panggilan API.

Tangani permintaan otorisasi

Saat aplikasi Google perlu melakukan penautan akun melalui aliran implisit OAuth 2.0, Google mengarahkan pengguna ke titik akhir otorisasi Anda dengan permintaan yang menyertakan parameter berikut:

Parameter titik akhir otorisasi
client_id ID klien yang Anda tetapkan ke Google.
redirect_uri URL yang Anda kirimi tanggapan atas permintaan ini.
state Nilai pembukuan yang dikembalikan ke Google tidak berubah di URI pengalihan.
response_type Jenis nilai yang akan dikembalikan dalam respons. Untuk aliran implisit OAuth 2.0, jenis respons selalu berupa token .
user_locale Setelan bahasa Akun Google dalam format RFC5646 digunakan untuk melokalkan konten Anda ke bahasa pilihan pengguna.

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

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

Agar titik akhir otorisasi Anda menangani permintaan masuk, lakukan langkah-langkah berikut:

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

    • Konfirmasikan bahwa client_id cocok dengan ID klien yang Anda tetapkan ke Google.
    • Konfirmasikan bahwa URL yang ditentukan oleh parameter redirect_uri memiliki format berikut:
      https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
      https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID
      
  2. Periksa apakah pengguna masuk ke layanan Anda. Jika pengguna tidak login, selesaikan proses login atau pendaftaran layanan Anda.

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

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

    • access_token : Token akses yang baru saja Anda buat
    • token_type : bearer string
    • state : Nilai status yang tidak dimodifikasi dari permintaan asli

    Berikut ini adalah contoh dari URL yang dihasilkan:

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

Penangan pengalihan OAuth 2.0 Google menerima token akses dan mengonfirmasi bahwa nilai state tidak berubah. Setelah Google mendapatkan token akses untuk layanan Anda, Google melampirkan token tersebut ke panggilan berikutnya ke API layanan Anda.

Memvalidasi implementasi Anda

You can validate your implementation by using the OAuth 2.0 Playground tool.

In the tool, do the following steps:

  1. Click Configuration to open the OAuth 2.0 Configuration window.
  2. In the OAuth flow field, select Client-side.
  3. In the OAuth Endpoints field, select Custom.
  4. Specify your OAuth 2.0 endpoint and the client ID you assigned to Google in the corresponding fields.
  5. In the Step 1 section, don't select any Google scopes. Instead, leave this field blank or type a scope valid for your server (or an arbitrary string if you don't use OAuth scopes). When you're done, click Authorize APIs.
  6. In the Step 2 and Step 3 sections, go through the OAuth 2.0 flow and verify that each step works as intended.

You can validate your implementation by using the Google Account Linking Demo tool.

In the tool, do the following steps:

  1. Click the Sign-in with Google button.
  2. Choose the account you'd like to link.
  3. Enter the service ID.
  4. Optionally enter one or more scopes that you will request access for.
  5. Click Start Demo.
  6. When prompted, confirm that you may consent and deny the linking request.
  7. Confirm that you are redirected to your platform.