Class GetUsersRequestParameters

Namespace

Keycloak.AuthServices.Sdk.Admin.Requests.Users

Assembly

Keycloak.AuthServices.Sdk.dll

Optional request parameters for the GetUsersAsync(string, GetUsersRequestParameters?, CancellationToken) endpoint. It can be called in three different ways.

1. Don’t specify any criteria. A stream of all users within that realm will be returned (limited by pagination).
2. If Search is specified, other criteria such as LastName will be ignored even though you may set them. The Search string will be matched against the FirstName, LastName, Username and the Email of a UserRepresentation.
3. If Search is unspecified but any of LastName, FirstName, Email or Username are specified, then those criteria are matched against their respective fields on a UserRepresentation entity. Combined with a logical AND.

public class GetUsersRequestParameters

Inheritance

object

GetUsersRequestParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BriefRepresentation

Defines whether brief representations are returned. Default is false.

public bool? BriefRepresentation { get; init; }

Property Value

bool?

Email

Search for a string contained in Email, or the complete Email if Exact is true.

public string? Email { get; init; }

Property Value

string

EmailVerified

Search for whether the email has been verified.

public bool? EmailVerified { get; init; }

Property Value

bool?

Enabled

Search for whether the UserRepresentation is enabled or not.

public bool? Enabled { get; init; }

Property Value

bool?

Exact

Defines whether the params LastName, FirstName, Email and Username must match exactly

public bool? Exact { get; init; }

Property Value

bool?

First

Pagination offset.

public int? First { get; init; }

Property Value

int?

FirstName

Search for a string contained in FirstName, or the complete FirstName if Exact is true.

public string? FirstName { get; init; }

Property Value

string

IdpAlias

Search for the alias of an Identity Provider linked to the UserRepresentation.

public string? IdpAlias { get; init; }

Property Value

string

IdpUserId

Search for a UserId at an Identity Provider linked to the UserRepresentation.

public string? IdpUserId { get; init; }

Property Value

string

LastName

Search for a string contained in LastName, or the complete LastName if Exact is true.

public string? LastName { get; init; }

Property Value

string

Max

Maximum results size. Default is 100.

public int? Max { get; init; }

Property Value

int?

Query

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

public string? Query { get; init; }

Property Value

string

Search

Search for a string contained in Username, FirstName, LastName or Email.

public string? Search { get; init; }

Property Value

string

Username

Search for a string contained in Username, or the complete Username if Exact is true.

public string? Username { get; init; }

Property Value

string