Obtenir les logs

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

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

Pour plus d’information sur tous les types d’événements possibles, leurs acronymes respectifs et leurs descriptions, consultez Log Event Type Codes.

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 : Index 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 (selon include_fields) du résultat; laisser vide pour récupérer tous les champs.
• include_fields : Indique si les champs précisé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 array directe de résultats (false, par défaut). Deprecated : ce champ est déprécié et devrait être retiré de l’usage. Consultez Search Engine V3 Breaking Changes

Pour plus d’information sur la liste des champs pouvant être utilisés dans fields et sort, consultez Searchable Fields.

Auth0 limite le nombre de journaux que vous pouvez retourner selon des critères de recherche à 100 journaux par requête. De plus, vous ne pouvez paginer que parmi 1 000 résultats de recherche. Si vous dépassez ce seuil, veuillez redéfinir votre recherche ou utiliser la méthode d’obtention des journaux par checkpoint.

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

• from : ID d’événement de journal à partir duquel commencer à récupérer les journaux. Vous pouvez limiter le nombre de journaux retournés à l’aide du paramètre take. Si vous utilisez from en même temps que q, from a préséance 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 de journaux à partir d’un ID de journal 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

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Logs.ListAsync(
            new ListLogsRequestParameters {
                Page = 1,
                PerPage = 1,
                Sort = "sort",
                Fields = "fields",
                IncludeFields = true,
                IncludeTotals = true,
                Search = "search"
            }
        );
    }

}

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

Index 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. p. ex. date:-1

fields · string

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

include_fields · boolean

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

include_totals · boolean

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

from · string

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

take · integer

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

search · string

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

Réponse

200

application/json

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

object[]

object

audience · string

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

client_id · string · défaut: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

ID du client (application).

client_name · string · défaut: My application Name

Nom du client (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 de journal.

isMobile · boolean

Indique si le client était un appareil mobile (true) ou un ordinateur de bureau, portable ou serveur (false).

location_info · object

Informations sur l’emplacement qui a déclenché cet événement en fonction de 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 associée à l’événement.

strategy_type · string

Type de stratégie associée à l’événement.

type · string · défaut: sapi

Type d'événement.

user_agent · string

Chaîne de l’agent utilisateur 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.