Récupérer les journaux

Récupère les entrées de log qui correspondent aux critères de recherche spécifiés (ou toutes les entrées de log si aucun critère n’est spécifié).

Définissez des critères de recherche personnalisés à l’aide du paramètre q, ou effectuez une recherche à partir d’un id de log précis (« rechercher à partir d’un checkpoint »).

Pour en savoir plus sur tous les types d’événement possibles, leurs acronymes respectifs et leur description, consultez Codes des types d’événement du journal.

Pour définir des critères de recherche personnalisés, utilisez les paramètres suivants :

• q : Critères de recherche utilisant la syntaxe de chaîne de requête
• page : Indice de page des résultats à retourner. La première page est 0.
• per_page : Nombre de résultats par page.
• sort : Champ à utiliser pour le tri, suivi de :1 pour l’ordre croissant et de :-1 pour l’ordre décroissant. Par exemple, date:-1
• fields : Liste de champs séparés par des virgules à inclure ou à exclure du résultat (selon include_fields), ou laissez vide pour récupérer tous les champs.
• include_fields : Indique si les champs spécifiés doivent être inclus (true) ou exclus (false).
• include_totals : Retourne les résultats dans un objet qui contient le nombre total de résultats (true) ou sous forme de tableau direct de résultats (false, par défaut). Obsolescence : ce champ est obsolète et doit être retiré de l’usage. Consultez Modifications incompatibles de Search Engine V3

Pour en savoir plus sur la liste des champs pouvant être utilisés dans fields et sort, consultez Champs interrogeables.

Auth0 limite le nombre de logs que vous pouvez retourner selon les critères de recherche à 100 logs par requête. De plus, vous ne pouvez paginer que parmi 1 000 résultats de recherche. Si vous dépassez ce seuil, redéfinissez votre recherche ou utilisez la méthode de récupération des logs par checkpoint.

Pour effectuer une recherche à partir d’un id de log de checkpoint, utilisez les paramètres suivants :

• from : Id d’événement du journal à partir duquel commencer à récupérer les logs. Vous pouvez limiter le nombre de logs retournés à l’aide du paramètre take. Si vous utilisez from en même temps que q, from est prioritaire et q est ignoré.
• take : Nombre d’entrées à récupérer lors de l’utilisation du paramètre from.

Important : lors de la récupération des logs à partir d’un id de log de checkpoint, tout paramètre autre que from et take sera ignoré, et l’ordre chronologique n’est pas garanti.

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>"
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

page · integer

Indice de page des résultats à retourner. La première page est 0.

Plage requise: x >= 0

per_page · integer

Nombre de résultats par page. La pagination est désactivée si le paramètre n’est pas envoyé. Par défaut : 50. Valeur maximale : 100

Plage requise: 0 <= x <= 100

sort · string

Champ à utiliser pour le tri, suivi de :1 pour l’ordre croissant et de :-1 pour l’ordre décroissant. Par ex. : date:-1

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure dans le résultat (selon la valeur fournie pour include_fields). Laissez vide pour récupérer tous les champs.

include_fields · boolean

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false)

include_totals · boolean

Renvoie les résultats sous forme de tableau lorsque la valeur est false (par défaut). Renvoie les résultats dans un objet qui contient aussi le nombre total de résultats lorsque la valeur est true.

from · string

ID de l’événement du journal à partir duquel commencer la sélection.

take · integer

Nombre d’entrées à récupérer lors de l’utilisation du paramètre from. Valeur par défaut : 50, maximum : 100

search · string

Récupère les log qui correspondent aux critères de recherche spécifiés. Ce paramètre peut être combiné avec tous les autres dans le point de terminaison /api/logs, mais il est indiqué séparément par souci de clarté. Si aucun champ n’est fourni, une recherche « commence par » insensible à la casse est effectuée dans tous les champs suivants : client_name, connection, user_name. Sinon, vous pouvez spécifier plusieurs champs et effectuer la recherche au format %field%:%search%, par exemple : application:node user:"[e-mail]". Les valeurs spécifiées sans guillemets sont mises en correspondance au moyen d’une recherche « commence par » insensible à la casse. Si des guillemets sont utilisés, une recherche exacte insensible à la casse est effectuée. Si plusieurs champs sont utilisés, les clauses sont jointes par l’opérateur AND.

Réponse

200

application/json

Log récupérés avec succès.

object[]

object

audience · string

Audience API à laquelle l’événement s’applique.

client_id · string · défaut: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

ID de l’application.

client_name · string · défaut: My application Name

Nom de l’application.

connection · string

Nom de la connexion à laquelle l’événement se rapporte.

connection_id · string

ID de la connexion à laquelle l’événement se rapporte.

date · string object · défaut: 2016-02-23T19:57:29.532Z

Date à laquelle l’événement s’est produit, au format ISO 8601.

description · string | null

Description de cet événement.

details · object

Détails supplémentaires utiles sur cet événement (la structure dépend du type d’événement).

hostname · string · défaut: 190.257.209.19

Nom d’hôte auquel l’événement s’applique.

ip · string · défaut: 190.257.209.19

Adresse IP de la source de l’événement du journal.

isMobile · boolean

Indique si l’application était un appareil mobile (true) ou un ordinateur de bureau, portable ou serveur (false).

location_info · object

Informations sur l’emplacement à l’origine de cet événement, selon l’ip.

Show child attributes

log_id · string

ID unique de l’événement.

scope · string · défaut: ""

Permissions de scope appliquées à l’événement.

security_context · object

Informations sur les signaux liés à la sécurité.

Show child attributes

strategy · string

Nom de la stratégie impliquée dans l’événement.

strategy_type · string

Type de stratégie impliquée dans l’événement.

type · string · défaut: sapi

Type d’événement.

user_agent · string

Chaîne de l’agent utilisateur provenant de l’appareil client à l’origine de l’événement.

user_id · string · défaut: auth0|56c75c4e42b6359e98374bc2

ID de l’utilisateur impliqué dans l’événement.

user_name · string

Nom de l’utilisateur impliqué dans l’événement.