Membuat dan mengelola undangan pengguna
Halaman ini menjelaskan cara melakukan beberapa operasi dasar dengan Cloud Identity User Invitation API.
Sebelum memulai
Catatan: Sebelum menggunakan Cloud Identity API, Anda harus menyiapkan Cloud Identity. Lihat Menyiapkan Cloud Identity untuk mengetahui petunjuknya.
Lakukan tugas berikut sebelum melanjutkan informasi di halaman ini:
- Baca ringkasan User Invitation API.
- Siapkan User Invitation API.
Menentukan kelayakan undangan
Seperti yang disebutkan dalam ringkasan,
agar dapat diundang, akun pengguna harus memenuhi beberapa kriteria. Anda dapat menggunakan metode
IsInvitableUser()
untuk mengetahui apakah akun pengguna tertentu memenuhi syarat.
REST
Untuk memeriksa kelayakan akun pengguna, panggil
customers.userinvitations.isInvitableUser()
dengan ID pelanggan dan alamat email akun.
Contoh permintaan
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[email protected]:isInvitableUser
Mengambil undangan pengguna
User Invitation API menyediakan metode untuk mengambil satu undangan pengguna dan mengambil semuanya. Saat mengambil semua undangan pengguna, Anda dapat memfilternya menurut status dan menetapkan urutan pengurutan.
Mengambil undangan pengguna tunggal
REST
Untuk mengambil undangan satu pengguna, panggil
customers.userinvitations.get()
dengan ID pelanggan dan alamat email akun.
Contoh permintaan
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[email protected]
Mengambil daftar undangan pengguna
Semua pengguna yang tidak dikelola akan otomatis muncul sebagai undangan dalam status NOT_YET_SENT hingga ditindaklanjuti oleh admin atau pengguna akhir. Setelah
undangan diterima oleh pengguna, akun tidak lagi dianggap
tidak dikelola.
- Jika Anda memanggil
customers.userinvitations.list()dengan status dalam permintaan, tindakan ini hanya akan menampilkan pengguna yang undangannya berada dalam status tersebut. - Jika Anda memanggil
customers.userinvitations.list()tanpa status dalam permintaan, semua undangan pengguna akan ditampilkan.
Anda dapat memeriksa beberapa status dengan menambahkan operator or di filter:
state=='accepted'||state=='declined'
REST
Untuk mengambil daftar undangan pengguna, panggil
customers.userinvitations.list()
dengan ID pelanggan dan parameter kueri yang diinginkan untuk memfilter, mengurutkan, dan
membuat penomoran halaman hasil. Contoh berikut menampilkan daftar semua pengguna yang tidak dikelola, diurutkan berdasarkan waktu pembaruan terakhir dalam urutan menurun.
Contoh permintaan
GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'
Mengirim undangan pengguna
Undangan pengguna tidak otomatis dikirim kepada pengguna yang memenuhi syarat. Setelah memiliki
daftar pengguna yang ingin diundang, Anda dapat menggunakan
metode customers.userinvitations.send().
Tindakan ini juga akan membuat undangan jika belum ada.
REST
Untuk mengirim email undangan pengguna kepada pengguna, panggil
customers.userinvitations.send()
dengan ID pelanggan dan alamat email akun pengguna.
Contoh permintaan
POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[email protected]:send
Membatalkan undangan pengguna
Undangan pengguna dapat dibatalkan hingga undangan tersebut diterima atau ditolak. Panggil metode customers.userinvitations.cancel() untuk membatalkan undangan.
REST
Untuk membatalkan undangan pengguna, panggil customers.userinvitations.cancel() dengan ID pelanggan dan alamat email akun pengguna.
Contoh permintaan
POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[email protected]:cancel