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

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

Suchparameter

Parameter
pageSize

integer

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

Ist dieses Feld negativ, 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.
orderBy

string

Optional. Die Reihenfolge, in der die UserLicenses aufgeführt sind. Der Wert muss eine durch Kommas getrennte Liste von Feldern sein. Die Standardreihenfolge ist aufsteigend. Wenn Sie ein Feld absteigend sortieren möchten, hängen Sie das Suffix „ desc“ an. Überflüssige Leerzeichen in der Syntax werden nicht berücksichtigt.

Unterstützte Felder:

  • licenseAssignmentState
  • userPrincipal
  • userProfile
  • last_login_date
  • updateTime

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

Beispiele:

  • userPrincipal desc, um nach userPrincipal in absteigender Reihenfolge zu sortieren.
  • licenseAssignmentState, um nach licenseAssignmentState in aufsteigender Reihenfolge zu sortieren.
  • last_login_date desc, um nach last_login_date in absteigender Reihenfolge zu sortieren.
  • updateTime desc, um nach updateTime in absteigender Reihenfolge zu sortieren.
  • last_login_date desc, userPrincipal, um nach last_login_date in absteigender Reihenfolge und dann nach userPrincipal in aufsteigender 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 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.