Class UsersRequestBuilder.UsersRequestBuilderGetQueryParameters

Namespace

Keycloak.AuthServices.Sdk.Kiota.Admin.Admin.Realms.Item.Users

Assembly

Keycloak.AuthServices.Sdk.Kiota.dll

Get users Returns a stream of users, filtered according to query parameters.

public class UsersRequestBuilder.UsersRequestBuilderGetQueryParameters

Inheritance

object

UsersRequestBuilder.UsersRequestBuilderGetQueryParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BriefRepresentation

Boolean which defines whether brief representations are returned (default: false)

[QueryParameter("briefRepresentation")]
public bool? BriefRepresentation { get; set; }

Property Value

bool?

Email

A String contained in email, or the complete email, if param "exact" is true

[QueryParameter("email")]
public string? Email { get; set; }

Property Value

string

EmailVerified

whether the email has been verified

[QueryParameter("emailVerified")]
public bool? EmailVerified { get; set; }

Property Value

bool?

Enabled

Boolean representing if user is enabled or not

[QueryParameter("enabled")]
public bool? Enabled { get; set; }

Property Value

bool?

Exact

Boolean which defines whether the params "last", "first", "email" and "username" must match exactly

[QueryParameter("exact")]
public bool? Exact { get; set; }

Property Value

bool?

First

Pagination offset

[QueryParameter("first")]
public int? First { get; set; }

Property Value

int?

FirstName

A String contained in firstName, or the complete firstName, if param "exact" is true

[QueryParameter("firstName")]
public string? FirstName { get; set; }

Property Value

string

IdpAlias

The alias of an Identity Provider linked to the user

[QueryParameter("idpAlias")]
public string? IdpAlias { get; set; }

Property Value

string

IdpUserId

The userId at an Identity Provider linked to the user

[QueryParameter("idpUserId")]
public string? IdpUserId { get; set; }

Property Value

string

LastName

A String contained in lastName, or the complete lastName, if param "exact" is true

[QueryParameter("lastName")]
public string? LastName { get; set; }

Property Value

string

Max

Maximum results size (defaults to 100)

[QueryParameter("max")]
public int? Max { get; set; }

Property Value

int?

Q

A query to search for custom attributes, in the format 'key1:value2 key2:value2'

[QueryParameter("q")]
public string? Q { get; set; }

Property Value

string

Search

A String contained in username, first or last name, or email. Default search behavior is prefix-based (e.g., foo or foo*). Use foo for infix search and "foo" for exact search.

[QueryParameter("search")]
public string? Search { get; set; }

Property Value

string

Username

A String contained in username, or the complete username, if param "exact" is true

[QueryParameter("username")]
public string? Username { get; set; }

Property Value

string