Membuat dan mengelola undangan pengguna

Halaman ini menjelaskan cara melakukan beberapa operasi dasar dengan Cloud Identity User Undangan 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 dengan informasi di halaman ini:

• Baca ringkasan API Undangan Pengguna.
• Siapkan User Undangan API.

Menentukan kelayakan undangan

Seperti yang tercantum dalam ringkasan, akun pengguna harus memenuhi beberapa kriteria untuk diundang. Anda dapat menggunakan metode IsInvitableUser() untuk mengetahui apakah akun pengguna tertentu memenuhi syarat atau tidak.

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/[e-mail]:isInvitableUser

Mengambil undangan pengguna

User Undangan API menyediakan metode untuk mengambil satu undangan pengguna dan mengambil semuanya. Saat mengambil semua undangan pengguna, Anda dapat secara opsional memfilternya berdasarkan status dan menetapkan urutan pengurutan.

Mengambil satu undangan pengguna

REST

Untuk mengambil satu undangan pengguna, panggil customers.userinvitations.get() dengan ID pelanggan dan alamat email akun.

Contoh permintaan

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]

Mengambil daftar undangan pengguna

Semua pengguna yang tidak dikelola akan muncul secara otomatis sebagai undangan di status NOT_YET_SENT hingga ditindaklanjuti oleh admin atau pengguna akhir. Setelah undangan diterima oleh pengguna, akun tersebut tidak lagi dianggap tidak dikelola.

• Jika Anda memanggil customers.userinvitations.list() dengan status yang diminta, permintaan tersebut 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 memberi nomor halaman pada hasil. Contoh berikut menampilkan daftar semua pengguna yang tidak dikelola, yang diurutkan berdasarkan waktu terakhir diperbarui dalam urutan menurun.

Contoh permintaan

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'

Mengirim undangan kepada pengguna

Undangan pengguna tidak otomatis dikirim ke 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/[e-mail]:send

Membatalkan undangan pengguna

Undangan pengguna dapat dibatalkan hingga disetujui 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/[e-mail]:cancel