Table of Contents

Class ListClientsRequestParameters

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll
[Serializable]
public record ListClientsRequestParameters : IEquatable<ListClientsRequestParameters>
Inheritance
ListClientsRequestParameters
Implements
Inherited Members
Extension Methods

Properties

AppType

Optional filter by a comma-separated list of application types.

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

Property Value

Optional<string>

ExternalClientId

Optional filter by the Client ID Metadata Document URI for CIMD-registered clients.

[JsonIgnore]
public Optional<string?> ExternalClientId { 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?>

IsFirstParty

Optional filter on whether or not a client is a first-party client.

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

Property Value

Optional<bool?>

IsGlobal

Optional filter on the global client parameter.

[JsonIgnore]
public Optional<bool?> IsGlobal { 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. Default value is 50, maximum value is 100

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

Property Value

Optional<int?>

Q

Advanced Query in Lucene syntax.
Permitted Queries:

  • client_grant.organization_id:{organization_id}
  • client_grant.allow_any_organization:true
Additional Restrictions:
  • Cannot be used in combination with other filters
  • Requires use of the from and take paging parameters (checkpoint paginatinon)
  • Reduced rate limits apply. See Rate Limit Configurations
Note: Recent updates may not be immediately reflected in query results 
[JsonIgnore]
public Optional<string?> Q { 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.