Class ListUsersRequestParameters

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

[Serializable]
public record ListUsersRequestParameters : IEquatable<ListUsersRequestParameters>

Inheritance

object

ListUsersRequestParameters

Implements

IEquatable<ListUsersRequestParameters>

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

Connection

Connection filter. Only applies when using search_engine=v1. To filter by connection with search_engine=v2|v3, use q=identities.connection:"connection_name"

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

Property Value

Optional<string>

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 inside an object that contains the total result count (true) or as a direct array of results (false, default).

[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.

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

Property Value

Optional<int?>

PrimaryOrder

If true (default), results are returned in a deterministic order. If false, results may be returned in a non-deterministic order, which can enhance performance for complex queries targeting a small number of users. Set to false only when consistent ordering and pagination is not required.

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

Property Value

Optional<bool?>

Q

Query in Lucene query string syntax. Some query types cannot be used on metadata fields, for details see Searchable Fields.

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

Property Value

Optional<string>

SearchEngine

The version of the search engine

[JsonIgnore]
public Optional<SearchEngineVersionsEnum?> SearchEngine { get; set; }

Property Value

Optional<SearchEngineVersionsEnum?>

Sort

Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at: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.