Method: projects.locations.userStores.userLicenses.list

Muestra las licencias de usuario.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre del recurso principal UserStore. Formato: projects/{project}/locations/{location}/userStores/{userStoreId}.

Los parámetros de consulta

Parámetros
pageSize

integer

Opcional. Tamaño de la página solicitado. El servidor puede devolver menos elementos de los solicitados. Si no se especifica, el valor predeterminado es 10. El valor máximo es 50; los valores superiores a este límite se convertirán a 50.

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

string

Opcional. Token de página recibido de una llamada userLicenses.list anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a userLicenses.list deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.
orderBy

string

Opcional. El orden en el que se muestran 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, añade el sufijo " desc". Los espacios redundantes en la sintaxis no son significativos.

Campos admitidos:

  • licenseAssignmentState
  • userPrincipal
  • userProfile
  • last_login_date
  • updateTime

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

Ejemplos:

  • userPrincipal desc para ordenar por userPrincipal en orden descendente.
  • licenseAssignmentState para ordenar por licenseAssignmentState en orden ascendente.
  • last_login_date desc para ordenar por last_login_date en orden descendente.
  • updateTime desc para ordenar por updateTime en orden descendente.
  • last_login_date desc, userPrincipal para ordenar por last_login_date en orden descendente y, a continuación, 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 a UserLicenseService.ListUserLicenses.

Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:

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

object (UserLicense)

Todos los UserLicense del cliente.
nextPageToken

string

Token que se puede enviar como pageToken para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.userStores.listUserLicenses

Para obtener más información, consulta la documentación de gestión de identidades y accesos.