Class GetUserCountRequestParameters

Namespace

Keycloak.AuthServices.Sdk.Admin.Requests.Users

Assembly

Keycloak.AuthServices.Sdk.dll

Optional request parameters for the IKeycloakClient.GetUserCountAsync endpoint. It can be called in three different ways.

1. Don’t specify any criteria. The number of all users within that realm will be returned, not limited by pagination.
2. If Search is specified, other criteria such as LastName will be ignored even though you set them. The Search string will be matched against the first and last name, the username and the email of a user.
3. If Search is unspecified but any of LastName, FirstName, Email or Username, those criteria are matched against their respective fields on a user entity. Combined with a logical and.

public class GetUserCountRequestParameters

Inheritance

object

GetUserCountRequestParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Email

An optional filter for a user's email.

public string? Email { get; init; }

Property Value

string

EmailVerified

Whether a user's email has to be verified to be included.

public bool? EmailVerified { get; init; }

Property Value

bool?

Enabled

Whether a user has to be enabled to be included.

public bool? Enabled { get; init; }

Property Value

bool?

FirstName

An optional filter for a user's first name.

public string? FirstName { get; init; }

Property Value

string

LastName

An optional filter for a user's last name.

public string? LastName { get; init; }

Property Value

string

Query

An optional query to search for custom attributes, in the format "key1:value2 key2:value2".

public string? Query { get; init; }

Property Value

string

Search

An optional search string for all the fields of a user. Default search behavior is prefix-based (e.g., foo or foo*). Use foo for infix search and "foo" for exact search.

public string? Search { get; init; }

Property Value

string

Username

An optional filter for a user's username.

public string? Username { get; init; }

Property Value

string