Method: projects.locations.userStores.userLicenses.list

Enumera las licencias de usuario.

Solicitud HTTP

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

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

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el nombre del recurso principal UserStore, 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 10. El valor máximo es 50, y los valores superiores se convertirán a 50.

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

string

Es 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.
orderBy

string

Es opcional. Es el orden en que se enumeran los 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 el sufijo " desc". Los caracteres de espacio redundantes en la sintaxis son insignificantes.

Campos admitidos:

  • licenseAssignmentState
  • userPrincipal
  • userProfile
  • last_login_date
  • updateTime

Si no se establece, el orden predeterminado es por userPrincipal.

Ejemplos:

  • userPrincipal desc para ordenar por userPrincipal de forma descendente.
  • licenseAssignmentState para ordenar por licenseAssignmentState de forma ascendente.
  • last_login_date desc para ordenar por last_login_date de forma descendente.
  • updateTime desc para ordenar por updateTime de forma descendente.
  • last_login_date desc, userPrincipal para ordenar por last_login_date en orden descendente y, luego, por userPrincipal en orden ascendente.

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)

Son todos los 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

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.