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,

  // Union field source can be only one of the following:
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
}
Felder
deleteUnassignedUserLicenses

boolean

Optional. Wenn „true“, wird die Nutzerlizenz gelöscht, wenn Nutzerlizenzen die zugehörige Lizenzkonfiguration entfernen. Standardmäßig (false) wird die Nutzerlizenz auf den Status „Nicht zugewiesen“ aktualisiert.
Union-Feld source. Erforderlich. Die Quelle der Eingabe. Für source ist nur einer der folgenden Werte zulässig:
inlineSource

object (InlineSource)

Die Inline-Quelle für die Eingabeinhalte für Dokument-Embeddings.

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

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 durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".