Method: projects.locations.userStores.userLicenses.list

Apresenta as licenças de utilizador.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso principal UserStore, formato: projects/{project}/locations/{location}/userStores/{userStoreId}.

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Tamanho da página solicitado. O servidor pode devolver menos itens do que o pedido. Se não for especificado, o valor predefinido é 10. O valor máximo é 50. Os valores superiores a 50 são convertidos para 50.

Se este campo for negativo, é devolvido um erro INVALID_ARGUMENT.
pageToken

string

Opcional. Um token de página, recebido de uma chamada userLicenses.list anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a userLicenses.list têm de corresponder à chamada que forneceu o token da página.
orderBy

string

Opcional. A ordem pela qual os UserLicenses são apresentados. O valor tem de ser uma lista de campos separados por vírgulas. A ordem de ordenação predefinida é ascendente. Para especificar a ordem descendente de um campo, acrescente o sufixo " desc". Os carateres de espaço redundantes na sintaxe são insignificantes.

Campos suportados:

  • licenseAssignmentState
  • userPrincipal
  • userProfile
  • last_login_date
  • updateTime

Se não estiver definido, a ordenação predefinida é por userPrincipal.

Exemplos:

  • userPrincipal desc para ordenar por userPrincipal por ordem descendente.
  • licenseAssignmentState para ordenar por licenseAssignmentState por ordem ascendente.
  • last_login_date desc para ordenar por last_login_date por ordem descendente.
  • updateTime desc para ordenar por updateTime por ordem descendente.
  • last_login_date desc, userPrincipal para ordenar por last_login_date por ordem descendente e, em seguida, por userPrincipal por ordem ascendente.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Mensagem de resposta para UserLicenseService.ListUserLicenses.

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

Representação JSON 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "nextPageToken": string
}
Campos
userLicenses[]

object (UserLicense)

Todos os UserLicenses do cliente.
nextPageToken

string

Um token que pode ser enviado como pageToken para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.userStores.listUserLicenses

Para mais informações, consulte a documentação do IAM.