Obtener registros

Recupera las entradas de registro que coincidan con los criterios de búsqueda especificados (o todas las entradas de registro si no se especifica ningún criterio).

Configura criterios de búsqueda personalizados mediante el parámetro q, o busca a partir de un id de registro específico (“buscar desde un punto de control”).

Para obtener más información sobre todos los tipos de eventos posibles, sus respectivos acrónimos y descripciones, consulta Log Event Type Codes.

Para configurar criterios de búsqueda personalizados, usa los siguientes parámetros:

• q: Criterios de búsqueda mediante sintaxis de cadena de consulta
• page: Índice de página de los resultados que se devolverán. La primera página es 0.
• per_page: Número de resultados por página.
• sort: Campo que se usará para ordenar, con :1 para orden ascendente y :-1 para orden descendente. Por ejemplo, date:-1
• fields: Lista de campos separados por comas para incluir o excluir (según include_fields) en el resultado; déjala vacía para recuperar todos los campos.
• include_fields: Si los campos especificados se incluirán (true) o se excluirán (false).
• include_totals: Devuelve los resultados dentro de un objeto que contiene el número total de resultados (true) o como un arreglo directo de resultados (false, valor predeterminado). Obsoleto: este campo está obsoleto y debe dejar de usarse. Consulta Search Engine V3 Breaking Changes

Para obtener más información sobre la lista de campos que se pueden usar en fields y sort, consulta Searchable Fields.

Auth0 limita el número de registros que puedes devolver por criterios de búsqueda a 100 registros por solicitud. Además, solo puedes paginar entre 1000 resultados de búsqueda. Si superas este umbral, redefine la búsqueda o usa el método para obtener registros por punto de control.

Para buscar a partir de un id de registro de punto de control, usa los siguientes parámetros:

• from: ID de evento de registro a partir del cual se empezarán a recuperar registros. Puedes limitar la cantidad de registros devueltos mediante el parámetro take. Si usas from al mismo tiempo que q, from tiene prioridad y q se ignora.
• take: Número de entradas que se recuperarán al usar el parámetro from.

Importante: Cuando recuperes registros a partir de un id de registro de punto de control, se ignorará cualquier parámetro distinto de from y take, y no se garantiza el orden por fecha.

GET https://{tenantDomain}/api/v2/logs

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ListLogsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        Sort: management.String(
            "sort",
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Q: management.String(
            "q",
        ),
    }
    client.Logs.List(
        context.TODO(),
        request,
    )
}

200

[
  {
    "audience": "<string>",
    "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
    "client_name": "My application Name",
    "connection": "<string>",
    "connection_id": "<string>",
    "date": "2016-02-23T19:57:29.532Z",
    "description": "<string>",
    "details": {},
    "hostname": "190.257.209.19",
    "ip": "190.257.209.19",
    "isMobile": true,
    "location_info": {
      "city_name": "<string>",
      "continent_code": "<string>",
      "country_code": "<string>",
      "country_code3": "<string>",
      "country_name": "<string>",
      "latitude": 123,
      "longitude": 123,
      "time_zone": "<string>"
    },
    "log_id": "<string>",
    "scope": "",
    "security_context": {
      "ja3": "<string>",
      "ja4": "<string>"
    },
    "strategy": "<string>",
    "strategy_type": "<string>",
    "type": "sapi",
    "user_agent": "<string>",
    "user_id": "auth0|56c75c4e42b6359e98374bc2",
    "user_name": "<string>"
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de consulta

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página. La paginación se desactiva si no se envía el parámetro. Valor predeterminado: 50. Valor máximo: 100

Rango requerido: 0 <= x <= 100

sort · string

Campo que se usará para ordenar, con :1 para orden ascendente y :-1 para descendente. Por ejemplo, date:-1

fields · string

Lista de campos separados por comas que se incluirán o excluirán (según el valor proporcionado para include_fields) en el resultado. Déjelo vacío para recuperar todos los campos.

include_fields · boolean

Indica si los campos especificados se incluirán (true) o se excluirán (false)

include_totals · boolean

Devuelve los resultados como un array cuando es false (predeterminado). Devuelve los resultados dentro de un objeto que también contiene el recuento total de resultados cuando es true.

from · string

Id del evento de registro a partir del cual iniciar la selección.

take · integer

Número de entradas que se recuperarán al usar el parámetro from. Valor predeterminado: 50; máximo: 100

search · string

Recupera registros que coinciden con los criterios de búsqueda especificados. Este parámetro puede combinarse con todos los demás en el endpoint /api/logs, pero se especifica por separado para mayor claridad. Si no se proporcionan campos, se realiza una búsqueda de "empieza por" sin distinción entre mayúsculas y minúsculas en todos los campos siguientes: client_name, connection, user_name. De lo contrario, puede especificar varios campos e indicar la búsqueda mediante %field%:%search%; por ejemplo: application:node user:"[e-mail]". Los valores especificados sin comillas se comparan mediante una búsqueda de "empieza por" sin distinción entre mayúsculas y minúsculas. Si se usan comillas, se utiliza una búsqueda exacta sin distinción entre mayúsculas y minúsculas. Si se usan varios campos, se utiliza el operador AND para unir las cláusulas.

Respuesta

200

application/json

Logs recuperados correctamente.

object[]

object

audience · string

Audiencia de la API a la que se aplica el evento.

client_id · string · predeterminado: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

ID del cliente (aplicación).

client_name · string · predeterminado: My application Name

Nombre del cliente (aplicación).

connection · string

Nombre de la conexión a la que se refiere el evento.

connection_id · string

ID de la conexión a la que se refiere el evento.

date · string object · predeterminado: 2016-02-23T19:57:29.532Z

Fecha en la que se produjo el evento, en formato ISO 8601.

description · string | null

Descripción de este evento.

details · object

Detalles adicionales útiles sobre este evento (la estructura depende del tipo de evento).

hostname · string · predeterminado: 190.257.209.19

Nombre de host al que se aplica el evento.

ip · string · predeterminado: 190.257.209.19

Dirección IP del origen del evento de registro.

isMobile · boolean

Indica si el cliente era un dispositivo móvil (true) o un equipo de escritorio, portátil o servidor (false).

location_info · object

Información sobre la ubicación que desencadenó este evento en función de la ip.

Show child attributes

log_id · string

ID único del evento.

scope · string · predeterminado: ""

Permisos de scope aplicados al evento.

security_context · object

Información sobre señales relacionadas con la seguridad.

Show child attributes

strategy · string

Nombre de la estrategia implicada en el evento.

strategy_type · string

Tipo de estrategia implicada en el evento.

type · string · predeterminado: sapi

Tipo de evento.

user_agent · string

Cadena de user agent del dispositivo cliente que provocó el evento.

user_id · string · predeterminado: auth0|56c75c4e42b6359e98374bc2

ID del usuario implicado en el evento.

user_name · string

Nombre del usuario implicado en el evento.