Mengambil grup perusahaan dengan Cloud OAuth API

Panduan ini menjelaskan cara mengambil keanggotaan grup perusahaan untuk pengguna tenaga kerja yang diautentikasi menggunakan endpoint /groups di Cloud OAuth API (cloudoauth.googleapis.com).

Endpoint /groups berfungsi sebagai endpoint klaim terdistribusi untuk integrasi OpenID Connect (OIDC), yang menampilkan keanggotaan grup perusahaan yang dipaginasi untuk pengguna di kumpulan identitas tenaga kerja yang mendukung SCIM dan yang tidak mendukung SCIM.

Sebelum memulai

  1. Konfigurasi workforce identity pool dan penyedia. Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi Workforce Identity Federation.
  2. Mendaftarkan klien OAuth dan menukar kode otorisasi dengan token akses. Untuk mengetahui informasi selengkapnya, lihat Menukarkan token dengan Cloud OAuth API.

  3. Aktifkan Cloud OAuth API.

    Peran yang diperlukan untuk mengaktifkan API

    Untuk mengaktifkan API, Anda memerlukan izin serviceusage.services.enable. Jika Anda membuat project, kemungkinan Anda sudah memiliki izin ini melalui peran Pemilik (roles/owner). Jika tidak, Anda bisa mendapatkan izin ini melalui peran Admin Penggunaan Layanan (roles/serviceusage.serviceUsageAdmin). Pelajari cara memberikan peran.

    Mengaktifkan API

Mengambil grup perusahaan

Untuk mengambil keanggotaan grup bagi pengguna yang diautentikasi, kirim permintaan GET HTTP ke endpoint /groups:

Metode common.groups Cloud OAuth API mengambil keanggotaan grup perusahaan untuk pengguna yang diautentikasi.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

  • TOKEN: token akses OAuth 2.0 berumur pendek yang diperoleh dari endpoint pertukaran token.
  • PAGE_SIZE: Opsional. Jumlah maksimum grup yang akan ditampilkan per halaman (antara 2.500 dan 5.000).
  • PAGE_TOKEN: Opsional. Token penomoran halaman yang diterima dari respons /groups sebelumnya di kolom next_page_token.

Metode HTTP dan URL: 

GET https://cloudoauth.googleapis.com/v1/common/groups?page_size=PAGE_SIZE&page_token=PAGE_TOKEN

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

Anda akan melihat respons JSON seperti berikut:

{
  "groups": [
    "security-admin@example.com",
    "data-analysts@example.com",
    "looker-developers@example.com"
  ],
  "next_page_token": "AE12aBcDeFgHiJkLmNoPqRsTuVwXyZ"
}

Kolom respons

Respons berisi kolom berikut:

Kolom Jenis Deskripsi
groups array of strings Daftar ID grup atau alamat email perusahaan yang menjadi anggota pengguna yang diautentikasi.
next_page_token string Token yang dapat Anda teruskan sebagai page_token dalam permintaan berikutnya untuk mengambil halaman hasil berikutnya. Jika kolom ini kosong atau dihilangkan, maka tidak ada halaman selanjutnya.

Untuk mengetahui informasi tentang respons error yang ditampilkan oleh endpoint /groups, lihat Error info pengguna dan grup Cloud OAuth.

Langkah berikutnya