{
"opencollection": "1.0.0",
"info": {
"name": "Auth0 Authentication actions logs API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "logs",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search Log Events",
"type": "http"
},
"http": {
"method": "GET",
"url": "{auth0_domain}/logs",
"params": [
{
"name": "page",
"value": "",
"type": "query",
"description": "Page index of the results to return. First page is 0."
},
{
"name": "per_page",
"value": "",
"type": "query",
"description": " Number of results per page. Paging is disabled if parameter not sent. Default: 50. Max value: 100"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Field to use for sorting appended with :1 for ascending and :-1 for descending. e.g. date:-1"
},
{
"name": "fields",
"value": "",
"type": "query",
"description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
},
{
"name": "include_fields",
"value": "",
"type": "query",
"description": "Whether specified fields are to be included (true) or excluded (false)"
},
{
"name": "include_totals",
"value": "",
"type": "query",
"description": "Return results as an array when false (default). Return results inside an object that also contains a total result count when true."
},
{
"name": "from",
"value": "",
"type": "query",
"description": "Log Event Id from which to start selection from."
},
{
"name": "take",
"value": "",
"type": "query",
"description": "Number of entries to retrieve when using the from parameter. Default 50, max 100"
},
{
"name": "search",
"value": "",
"type": "query",
"description": "Retrieves logs that match the specified search criteria. This parameter can be combined with all the others in the /api/logs endpoint but is specified separately for clarity.\nIf no fields are provided a case insensitive 'starts with' search is performed on all of the following fields: client_name, connection, user_name. Otherwise, you can specify multiple fields and specify the search using the %field%:%search%, for example: application:node user:\"John@contoso.com\".\nValues specified without quotes are matched using a case insensitive 'starts with' search. If quotes are used a case insensitve exact search is used. If multiple fields are used, the AND operator is used to join the clauses."
}
]
},
"docs": "Retrieve log entries that match the specified search criteria (or all log entries if no criteria specified).\n\nSet custom search criteria using the q parameter, or search from a specific log ID (\"search from checkpoint\").\n\nFor more information on all possible event types, their respective acronyms, and descriptions, see Log Event Type Codes.\n\n