Method: projects.locations.userStores.userLicenses.list

Lista as licenças de usuário.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

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

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o padrão será 10. O valor máximo é 50. Valores acima disso serão convertidos para 50.

Se esse campo for negativo, um erro INVALID_ARGUMENT será retornado.
pageToken

string

Opcional. Um token de página recebido de uma chamada userLicenses.list anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para userLicenses.list precisam corresponder à chamada que forneceu o token da página.
filter

string

Opcional. Filtro para a solicitação de lista.

Campos compatíveis:

  • licenseAssignmentState

Exemplos:

  • licenseAssignmentState = ASSIGNED para listar as licenças de usuário atribuídas.
  • licenseAssignmentState = NO_LICENSE para listar usuários sem licença.
  • licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN para listar usuários que tentaram fazer login, mas não têm uma licença atribuída.
  • licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN para filtrar usuários que tentaram fazer login, mas não têm uma licença atribuída.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para UserLicenseService.ListUserLicenses.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

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 recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.userStores.listUserLicenses

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