Class ListLogsRequestParameters

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

[Serializable]
public record ListLogsRequestParameters : IEquatable<ListLogsRequestParameters>

Inheritance

object

ListLogsRequestParameters

Implements

IEquatable<ListLogsRequestParameters>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Properties

Fields

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.

[JsonIgnore]
public Optional<string?> Fields { get; set; }

Property Value

Optional<string>

IncludeFields

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

[JsonIgnore]
public Optional<bool?> IncludeFields { get; set; }

Property Value

Optional<bool?>

IncludeTotals

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

[JsonIgnore]
public Optional<bool?> IncludeTotals { get; set; }

Property Value

Optional<bool?>

Page

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

[JsonIgnore]
public Optional<int?> Page { get; set; }

Property Value

Optional<int?>

PerPage

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

[JsonIgnore]
public Optional<int?> PerPage { get; set; }

Property Value

Optional<int?>

Search

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.

[JsonIgnore]
public Optional<string?> Search { get; set; }

Property Value

Optional<string>

Sort

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

[JsonIgnore]
public Optional<string?> Sort { get; set; }

Property Value

Optional<string>

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.