Method: projects.locations.userStores.userLicenses.list

Liste les licences utilisateur.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource parent [UserStore][], au format projects/{project}/locations/{location}/userStores/{userStoreId}.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, la valeur par défaut est 10. La valeur maximale est 50. Les valeurs supérieures sont réduites à 50.

Si ce champ est négatif, une erreur INVALID_ARGUMENT est renvoyée.
pageToken

string

Facultatif. Jeton de page reçu d'un appel userLicenses.list précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à userLicenses.list doivent correspondre à l'appel ayant fourni le jeton de page.
filter

string

Facultatif. Filtre pour la demande de liste.

Champs acceptés :

  • licenseAssignmentState

Exemples :

  • licenseAssignmentState = ASSIGNED pour lister les licences utilisateur attribuées.
  • licenseAssignmentState = NO_LICENSE pour lister les utilisateurs sans licence.
  • licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN pour lister les utilisateurs qui ont tenté de se connecter, mais auxquels aucune licence n'a été attribuée.
  • licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN pour filtrer les utilisateurs qui ont tenté de se connecter, mais auxquels aucune licence n'a été attribuée.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour UserLicenseService.ListUserLicenses.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "nextPageToken": string
}
Champs
userLicenses[]

object (UserLicense)

Tous les UserLicense du client.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.userStores.listUserLicenses

Pour en savoir plus, consultez la documentation IAM.