Récupérer les journaux à l’aide de la Management API

Découvrez comment récupérer des journaux à l’aide du endpoint get_logs de l’Auth0 Management API, par point de contrôle ou selon des critères de recherche.

Vous pouvez utiliser la Management API pour récupérer jusqu’à 100 journaux par requête au moyen du endpoint /get_logs, qui prend en charge deux modes d’utilisation :

• Par point de contrôle : Recommandé si vous souhaitez exporter des journaux vers un service externe d’analyse de données.
• Selon des critères de recherche : Utilisé par le Dashboard.

Les journaux stockés par Auth0 sont assujettis à une période de conservation basée sur votre abonnement Auth0. Pour en savoir plus, consultez Log Data Retention.

Vous pouvez également utiliser ces endpoints pour rechercher des journaux :

• /api/v2/logs/{id}: Récupère l’entrée de journal associée à l’ID de journal fourni.
• /api/v2/users/{user_id}/logs: Récupère les journaux pour un ID d’utilisateur précis.

​

Récupérer les journaux par point de contrôle

Cette méthode vous permet de récupérer les journaux plus récents qu’un log_id donné. Elle est couramment utilisée pour envoyer vos journaux vers un système externe, comme Splunk, Datadog, Application Insights, Mixpanel, et bien d’autres.

Pour effectuer une recherche par point de contrôle, utilisez les paramètres suivants :

Paramètre	Description
from	ID de l’événement de journal à partir duquel commencer à récupérer les journaux. Vous pouvez limiter le nombre de journaux à l’aide du paramètre take.
take	Le nombre total d’entrées à récupérer lors de l’utilisation du paramètre from.

Tout paramètre autre que from et take sera ignoré. Les journaux sont triés selon le log_id.

​

Sémantique

La récupération des journaux par point de contrôle suit la sémantique suivante :

• Tous les journaux accessibles selon les autorisations de votre rôle seront renvoyés
• Les journaux sont triés selon le log_id, plutôt que selon leur heure de génération, afin d’éviter de sauter des enregistrements en raison de délais du système Auth0
• La pagination n’est pas limitée, ce qui signifie qu’il n’y a aucune limite, contrairement à la limite de 1,000 enregistrements lors de la récupération des journaux selon des critères de recherche

​

Pagination

Lors de la récupération des journaux par point de contrôle, seule la première requête doit être effectuée manuellement. Chaque requête suivante doit être effectuée à l’aide de l’URL associée à la relation next dans l’en-tête Link. Cela simplifie l’intégration avec l’API et permet à Auth0 d’effectuer des optimisations sans nuire à l’expérience client.

​

Exemple

Supposons que le nom de votre tenant dans us est acme. Pour commencer à récupérer des enregistrements à partir d’un point de contrôle :

1. Récupérez le log_id de n’importe quel journal de votre système. Exemple : 90020211201185132572079310688835925971249535794074878050.

2. Faites une requête à https://TENANT_NAME.LOCALITY.auth0.com/api/v2/logs?from=LOG_ID&take=100 pour obtenir les 100 journaux suivants, plus récents que le LOG_ID indiqué.

3. La réponse HTTP contiendra

   1. Un tableau JSON de 0 à 100 journaux plus récents que le LOG_ID indiqué
   2. Un en-tête HTTP Link avec une relation next

4. Si l’ensemble de résultats est vide, vous recevrez un tableau vide, et la relation next correspondra à la même URL que celle utilisée dans la requête la plus récente

​

Récupérer les journaux selon des critères de recherche

Cette méthode vous permet de récupérer les journaux correspondant aux critères de recherche spécifiés ou, si aucun critère n’est fourni, de lister tous les journaux. Pour effectuer une recherche par critères, utilisez les paramètres suivants :

Paramètre	Description
q	Critères de recherche utilisant la syntaxe de chaîne de requête.
page	Le numéro de page commençant à zéro.
per_page	Le nombre d’entrées par page.
sort	Le champ à utiliser pour le tri. Utilisez field:order, où order vaut 1 pour l’ordre croissant et -1 pour l’ordre décroissant. Par exemple : date:-1.
fields	Une liste de champs séparés par des virgules à inclure ou à exclure (selon include_fields) dans le résultat. Laissez vide pour récupérer tous les champs.
include_fields	true si les champs spécifiés doivent être inclus dans le résultat, false sinon. La valeur par défaut est true.

Pour voir la liste des champs et des paramètres de tri qui peuvent être utilisés dans la requête de recherche, consultez Log Search Query Syntax.

​

Limites

En plus de la limite de 100 journaux par requête pour récupérer les journaux, vous pouvez parcourir par pagination un maximum de 1 000 résultats de recherche.

Si vous obtenez l’erreur 414 Request-URI Too Large, cela signifie que votre chaîne de requête dépasse la longueur prise en charge. Dans ce cas, affinez votre recherche.

Limites des champs de recherche de Private Cloud

Les champs suivants sont interrogeables uniquement dans Private Cloud :

• user
• connection
• application
• type
• ip

Utilisez des guillemets doubles pour les recherches exactes (p. ex., application:\"test\" recherchera tous les événements de journal associés à l’application nommée test, tandis que application:test recherchera des événements de journal pour les applications dont le nom contient « test ».

​

Pour en savoir plus

• Codes de type de journal
• Syntaxe des requêtes de recherche dans les journaux
• Rétention des données de journal