Method: projects.locations.userStores.batchUpdateUserLicenses

Aktualisiert die Nutzerlizenz. Diese Methode wird verwendet, um Nutzern Lizenzen im Batch zuzuweisen oder zu entziehen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des übergeordneten UserStore im Format projects/{project}/locations/{location}/userStores/{userStoreId}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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.
}
Felder
deleteUnassignedUserLicenses

boolean

Optional. Wenn „true“ festgelegt ist und Nutzerlizenzen die zugehörige Lizenzkonfiguration entfernen, wird die Nutzerlizenz gelöscht. Standardmäßig (false) wird die Nutzerlizenz auf den Status „Nicht zugewiesen“ aktualisiert.
Erforderlich. Die Quelle der Eingabe. Die folgende Liste enthält sich gegenseitig ausschließende Felder. In einer Antwort wird höchstens eines der Felder festgelegt:
inlineSource

object (InlineSource)

Die Inline-Quelle für die Eingabeinhalte für die Lizenzzuweisung.
Ende der sich gegenseitig ausschließenden Felder.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.userStores.batchUpdateUserLicenses

Weitere Informationen finden Sie in der IAM-Dokumentation.

InlineSource

Die Inline-Quelle für die Eingabekonfiguration für die Methode „userStores.batchUpdateUserLicenses“.

JSON-Darstellung 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "updateMask": string
}
Felder
userLicenses[]

object (UserLicense)

Erforderlich. Eine Liste der zu aktualisierenden Nutzerlizenzen. Jede Nutzerlizenz muss eine gültige UserLicense.user_principal haben.
updateMask

string (FieldMask format)

Optional. Die Liste der zu aktualisierenden Felder.

Dies ist eine kommagetrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".