Method: projects.locations.userStores.userLicenses.list

Mencantumkan Lisensi Pengguna.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

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

Parameter kueri

Parameter
pageSize

integer

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

Jika kolom ini negatif, error INVALID_ARGUMENT akan ditampilkan.
pageToken

string

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

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

string

Opsional. Urutan UserLicense dicantumkan. Nilainya 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:

  • licenseAssignmentState
  • userPrincipal
  • userProfile
  • last_login_date
  • updateTime

Jika tidak ditetapkan, pengurutan defaultnya adalah berdasarkan userPrincipal.

Contoh:

  • userPrincipal desc untuk mengurutkan menurut userPrincipal dari atas ke bawah.
  • licenseAssignmentState untuk mengurutkan menurut licenseAssignmentState dari bawah ke atas.
  • last_login_date desc untuk mengurutkan menurut last_login_date dari atas ke bawah.
  • updateTime desc untuk mengurutkan menurut updateTime dari atas ke bawah.
  • last_login_date desc, userPrincipal untuk mengurutkan berdasarkan last_login_date dari atas ke bawah, lalu berdasarkan userPrincipal dari bawah ke atas.

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 akan 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

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.