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 meno elementi di quelli richiesti. Se non specificato, il valore predefinito è 100. Il valore massimo è 1000; i valori superiori a 1000 verranno forzati a 1000.

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

string

Facoltativo. Filtro per la richiesta di elenco.

Campi supportati:

  • licenseAssignmentState
  • userPrincipal * Esempi:

  • licenseAssignmentState = ASSIGNED per elencare le licenze utente assegnate.

  • licenseAssignmentState = NO_LICENSE per elencare gli utenti senza licenza.
  • licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN per elencare gli utenti che hanno tentato l'accesso, ma a cui non è stata assegnata alcuna licenza.
  • licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN per filtrare gli utenti che hanno tentato di accedere, ma a cui non è stata assegnata alcuna licenza.
  • userPrincipal = user1@example.com per elencare le licenze utente per user1@example.com.
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 (al momento è supportato solo userPrincipal):

  • userPrincipal

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

Esempi:

  • userPrincipal per ordinare per userPrincipal in ordine crescente.
  • userPrincipal desc per ordinare per userPrincipal in ordine decrescente.

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
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.userStores.listUserLicenses

Per saperne di più, consulta la documentazione di IAM.