Method: projects.locations.userStores.userLicenses.list

Elenca le licenze utente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa UserStore principale, formato: projects/{project}/locations/{location}/userStores/{userStoreId}.

Parametri di query

Parametri
pageSize

integer

Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire un numero di elementi inferiore a quello richiesto. Se non specificato, il valore predefinito è 10. Il valore massimo è 50; i valori superiori a 50 verranno forzati a 50.

Se questo campo è negativo, viene restituito un errore INVALID_ARGUMENT.
pageToken

string

Facoltativo. Un token di pagina, ricevuto da una precedente chiamata userLicenses.list. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a userLicenses.list devono corrispondere alla chiamata che ha fornito il token di pagina.
orderBy

string

Facoltativo. L'ordine in cui sono elencati i UserLicense. Il valore deve essere un elenco di campi separati da virgole. L'ordine di ordinamento predefinito è crescente. Per specificare l'ordine decrescente per un campo, aggiungi il suffisso " desc". Gli spazi ridondanti nella sintassi non sono significativi.

Campi supportati:

  • licenseAssignmentState
  • userPrincipal
  • userProfile
  • last_login_date
  • updateTime

Se non viene impostato, l'ordinamento predefinito è per userPrincipal.

Esempi:

  • userPrincipal desc per ordinare per userPrincipal in ordine decrescente.
  • licenseAssignmentState per ordinare per licenseAssignmentState in ordine crescente.
  • last_login_date desc per ordinare per last_login_date in ordine decrescente.
  • updateTime desc per ordinare per updateTime in ordine decrescente.
  • last_login_date desc, userPrincipal per ordinare per last_login_date in ordine decrescente e poi per userPrincipal in ordine crescente.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per UserLicenseService.ListUserLicenses.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "nextPageToken": string
}
Campi
userLicenses[]

object (UserLicense)

Tutti i UserLicense del cliente.
nextPageToken

string

Un token, che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.userStores.listUserLicenses

Per ulteriori informazioni, consulta la documentazione di IAM.