Method: projects.locations.userStores.userLicenses.list

Hier werden die Nutzerlizenzen aufgeführt.

HTTP-Anfrage

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

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

Abfrageparameter

Parameter
pageSize

integer

Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn nicht angegeben, wird standardmäßig 10 verwendet. Der Höchstwert beträgt 50. Werte über 50 werden implizit auf 50 umgewandelt.

Wenn dieses Feld negativ ist, wird der Fehler INVALID_ARGUMENT 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

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.

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

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.