Auth0 Node.js SDK - v5.1.0
    Preparing search index...

    Interface ListLogsRequestParameters

    {
     *         page: 1,
     *         per_page: 1,
     *         sort: "sort",
     *         fields: "fields",
     *         include_fields: true,
     *         include_totals: true,
     *         search: "search"
     *     }
    interface ListLogsRequestParameters {
        page?: number | null;
        per_page?: number | null;
        sort?: string | null;
        fields?: string | null;
        include_fields?: boolean | null;
        include_totals?: boolean | null;
        search?: string | null;
    }
    Index

    Properties

    page? per_page? sort? fields? include_fields? include_totals? search?

    Properties

    Optionalpage

    page?: number | null

    Page index of the results to return. First page is 0.

    Optionalper_page

    per_page?: number | null

    Number of results per page. Paging is disabled if parameter not sent. Default: 50. Max value: 100

    sort?: string | null

    Field to use for sorting appended with :1 for ascending and :-1 for descending. e.g. date:-1

    fields?: string | null

    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.

    include_fields?: boolean | null

    Whether specified fields are to be included (true) or excluded (false)

    include_totals?: boolean | null

    Return results as an array when false (default). Return results inside an object that also contains a total result count when true.

    search?: string | null

    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. If 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". Values 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.

    Settings

    Member Visibility

    On This Page

    Properties