Method: projects.locations.userStores.userLicenses.list

Muestra las licencias de usuario.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. El nombre del recurso UserStore superior, con el formato projects/{project}/locations/{location}/userStores/{userStoreId}.

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el valor predeterminado es 100. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.

Si este campo es negativo, se muestra un error INVALID_ARGUMENT.
pageToken

string

Opcional. Un token de página, recibido desde una llamada userLicenses.list anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a userLicenses.list deben coincidir con la llamada que proporcionó el token de la página.
filter

string

Opcional. Filtro para la solicitud de lista.

Campos admitidos:

  • licenseAssignmentState
  • userPrincipal * Ejemplos:

  • licenseAssignmentState = ASSIGNED para mostrar las licencias de usuario asignadas.

  • licenseAssignmentState = NO_LICENSE para mostrar los usuarios sin licencia.
  • licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN para mostrar los usuarios que intentaron acceder, pero no se les asignó ninguna licencia.
  • licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN para filtrar a los usuarios que intentaron acceder, pero no se les asignó ninguna licencia.
  • userPrincipal = user1@example.com para mostrar la licencia de usuario de user1@example.com.
orderBy

string

Opcional. El orden en el que se muestran las UserLicense. El valor debe ser una lista de campos separados por comas. El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente de un campo, agrega un sufijo " desc". Los caracteres de espacio redundantes en la sintaxis son insignificantes.

Campos admitidos (por ahora, solo se admite userPrincipal):

  • userPrincipal

Si no se configura, el orden predeterminado es userPrincipal.

Ejemplos:

  • userPrincipal para ordenar por userPrincipal en orden ascendente.
  • userPrincipal desc para ordenar por userPrincipal en orden descendente.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para UserLicenseService.ListUserLicenses.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "nextPageToken": string
}
Campos
userLicenses[]

object (UserLicense)

Todas las UserLicense del cliente.
nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.userStores.listUserLicenses

Para obtener más información, consulta la documentación de IAM.