Method: projects.locations.userStores.userLicenses.list

Mencantumkan Lisensi Pengguna.

Permintaan HTTP

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/userStores/*}/userLicenses

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib diisi. Nama resource UserStore induk, format: projects/{project}/locations/{location}/userStores/{userStoreId}.

Parameter kueri

Parameter
pageSize

integer

Opsional. Ukuran halaman yang diminta. Server dapat menampilkan item yang lebih sedikit dari yang diminta. Jika tidak ditentukan, nilai defaultnya adalah 10. Nilai maksimumnya adalah 50; nilai di atas 50 akan dipaksa menjadi 50.

Jika kolom ini negatif, error INVALID_ARGUMENT akan ditampilkan.
pageToken

string

Opsional. Token halaman, yang diterima dari panggilan userLicenses.list sebelumnya. Berikan token ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk userLicenses.list harus sesuai dengan panggilan yang memberikan token halaman.
filter

string

Opsional. Filter untuk permintaan daftar.

Kolom yang didukung:

  • licenseAssignmentState
  • userPrincipal * Contoh:

  • licenseAssignmentState = ASSIGNED untuk mencantumkan lisensi pengguna yang ditetapkan.

  • licenseAssignmentState = NO_LICENSE untuk mencantumkan pengguna yang tidak memiliki lisensi.
  • licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN untuk mencantumkan pengguna yang mencoba login tetapi tidak ada lisensi yang ditetapkan.
  • licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN untuk memfilter pengguna yang mencoba login tetapi tidak ada lisensi yang ditetapkan.
  • userPrincipal = user1@abc.com untuk mencantumkan lisensi pengguna untuk user1@abc.com.
orderBy

string

Opsional. Urutan pencantuman UserLicense. Nilai harus berupa daftar kolom yang dipisahkan koma. Urutan pengurutan default adalah menaik. Untuk menentukan urutan menurun untuk kolom, tambahkan akhiran " desc". Karakter spasi yang berlebihan dalam sintaksis tidak signifikan.

Kolom yang didukung (hanya userPrincipal yang didukung untuk saat ini):

  • userPrincipal

Jika tidak ditetapkan, urutan defaultnya adalah berdasarkan userPrincipal.

Contoh:

  • userPrincipal untuk mengurutkan berdasarkan userPrincipal dalam urutan menaik.
  • userPrincipal desc untuk mengurutkan berdasarkan userPrincipal dalam urutan menurun.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk UserLicenseService.ListUserLicenses.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "nextPageToken": string
}
Kolom
userLicenses[]

object (UserLicense)

Semua UserLicense pelanggan.
nextPageToken

string

Token, yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak ada halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • discoveryengine.userStores.listUserLicenses

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.