Method: projects.locations.userStores.batchUpdateUserLicenses

Memperbarui Lisensi Pengguna. Metode ini digunakan untuk menetapkan/membatalkan penetapan lisensi secara batch kepada pengguna.

Permintaan HTTP


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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

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

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "deleteUnassignedUserLicenses": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineSource": {
    object (InlineSource)
  }
  // End of mutually exclusive fields.
}
Kolom
deleteUnassignedUserLicenses

boolean

Opsional. Jika benar (true), jika lisensi pengguna yang dihapus terkait dengan konfigurasi lisensi, lisensi pengguna akan dihapus. Secara default, yang salah (false), lisensi pengguna akan diperbarui ke status belum ditetapkan.

Wajib. Sumber input. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
inlineSource

object (InlineSource)

Sumber inline untuk konten input penetapan lisensi.

Akhir kolom yang saling eksklusif.

Isi respons

Jika berhasil, isi respons akan memuat instance Operation.

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.batchUpdateUserLicenses

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

InlineSource

Sumber inline untuk konfigurasi input metode userStores.batchUpdateUserLicenses.

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

object (UserLicense)

Wajib. Daftar lisensi pengguna yang akan diperbarui. Setiap lisensi pengguna harus memiliki UserLicense.user_principal yang valid.

updateMask

string (FieldMask format)

Opsional. Daftar kolom yang akan diperbarui.

Ini adalah daftar nama kolom yang sepenuhnya valid dan dipisahkan koma. Contoh: "user.displayName,photo".