Class SearchClientGrantsRequestParameters

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

[Serializable]
public record SearchClientGrantsRequestParameters : IEquatable<SearchClientGrantsRequestParameters>

Inheritance

object

SearchClientGrantsRequestParameters

Implements

IEquatable<SearchClientGrantsRequestParameters>

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 in the response. Works with the include_fields parameter to control projection mode.

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

Property Value

Optional<string>

From

Cursor for the next page of results. Use the value from the next field in the previous response.

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

Property Value

Optional<string>

IncludeFields

Controls field projection mode. Set to true to include only fields specified in the fields parameter. Set to false to exclude fields specified in the fields parameter. Defaults to true if not specified.

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

Property Value

Optional<bool?>

Parser

Query parser to use for the filter expression. Use "scim" for SCIM filter syntax or "lucene" for Lucene query syntax (default).

[JsonIgnore]
public Optional<SearchParserEnum?> Parser { get; set; }

Property Value

Optional<SearchParserEnum?>

Q

Filter expression in SCIM or Lucene syntax (depending on parser parameter). SCIM examples: audience eq "https://api.example.com", client_id eq "cli_abc", subject_type eq "client", allow_any_organization eq true, default_for eq "third_party_clients", audience co "example" and organization_id eq "org_123". SCIM operators: eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or.

Supported Fields:

• audience - Filter by audience (eq, ne, sw, co, ew, pr)
• client_id - Filter by client ID (eq, ne, sw, pr)
• subject_type - Filter by subject type (eq, ne, sw, pr)
• allow_any_organization - Filter by allow_any_organization (eq, ne, pr)
• organization_id - Filter by organization ID (eq, ne, sw, pr)
• updated_at - Filter by last update date (eq, ne, gt, ge, lt, le, pr)
• default_for - Filter by default grant group (eq, ne, sw, pr)

Maximum 5 filter operations per query. Results are eventually consistent and may not reflect recent updates.

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

Property Value

Optional<string>

Sort

Field name to sort results by in ascending order. Defaults to insertion order (oldest first) if not provided.

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

Property Value

Optional<ClientGrantSortFieldEnum?>

Take

Maximum number of results to return per page (1-100). Defaults to 50.

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

Property Value

Optional<int?>

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.