Class GetUsersRequest

Namespace

Auth0.ManagementApi.Models

Assembly

Auth0.ManagementApi.dll

Specifies criteria to use when querying all users.

public class GetUsersRequest

Inheritance

object

GetUsersRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Connection

Connection filter. Only applies when SearchEngine is set to v1. To filter by connection with SearchEngine set to v2 or v3, set Query to identities.connection:"connection_name" instead.

public string Connection { get; set; }

Property Value

string

Fields

A comma separated list of fields to include or exclude (depending on IncludeFields) from the result, empty to retrieve all fields.

public string Fields { get; set; }

Property Value

string

IncludeFields

Specifies whether the fields specified in Fields should be included or excluded in the result.

public bool? IncludeFields { get; set; }

Property Value

bool?

Query

Query in Lucene query string syntax.

public string Query { get; set; }

Property Value

string

Remarks

Not all metadata fields are searchable when using search engine v2. When using search engine v3, some query types cannot be used on metadata fields.

SearchEngine

The version of the search engine to use.

public string SearchEngine { get; set; }

Property Value

string

Remarks

Will default to v2 if no value is passed. Default will change to v3 on 2018/11/13. For more info see the online documentation.

Sort

The field to use for sorting. 1 == ascending and -1 == descending.

public string Sort { get; set; }

Property Value

string