Method: projects.locations.userStores.userLicenses.list

Hier werden die Nutzerlizenzen aufgeführt.

HTTP-Anfrage

:


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

Für die URLs wird die Syntax der gRPC-Transcodierung verwendet.

Pfadparameter

Parameter
parent

string

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

Abfrageparameter

Parameter
pageSize

integer

Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn sie nicht angegeben ist, wird sie standardmäßig auf 100 gesetzt. Der Höchstwert liegt bei 1.000. Alle Werte darüber werden implizit in 1.000 umgewandelt.

Wenn dieses Feld negativ ist, wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen userLicenses.list-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für userLicenses.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
filter

string

Optional. Filter für die Listenanfrage.

Unterstützte Felder:

  • licenseAssignmentState
  • userPrincipal * Beispiele:

  • licenseAssignmentState = ASSIGNED, um die zugewiesenen Nutzerlizenzen aufzulisten.

  • licenseAssignmentState = NO_LICENSE, um nicht lizenzierte Nutzer aufzulisten.
  • licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN, um Nutzer aufzulisten, die versucht haben, sich anzumelden, denen aber keine Lizenz zugewiesen ist.
  • licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN, um Nutzer herauszufiltern, die versucht haben, sich anzumelden, denen aber keine Lizenz zugewiesen ist.
  • userPrincipal = user1@example.com, um die Nutzerlizenz für user1@example.com aufzulisten.
orderBy

string

Optional. Die Reihenfolge, in der die UserLicense-Elemente aufgeführt sind. Der Wert muss eine durch Kommas getrennte Liste der Felder sein. Die Standardsortierreihenfolge ist aufsteigend. Wenn Sie absteigend sortieren möchten, nutzen Sie das Suffix „desc“. Überflüssige Leerzeichen in der Syntax werden nicht berücksichtigt.

Unterstützte Felder (derzeit wird nur userPrincipal unterstützt):

  • userPrincipal

Wenn keine Angabe erfolgt, wird standardmäßig nach userPrincipal sortiert.

Beispiele:

  • userPrincipal, um nach userPrincipal in aufsteigender Reihenfolge zu sortieren.
  • userPrincipal desc, um nach userPrincipal in absteigender Reihenfolge zu sortieren.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für UserLicenseService.ListUserLicenses.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

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

object (UserLicense)

Alle UserLicense-Elemente des Kunden.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

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

Weitere Informationen finden Sie in der IAM-Dokumentation.