Table of Contents

Namespace Keycloak.AuthServices.Sdk.Admin.Requests.Users

Classes

ExecuteActionsEmailRequest

Send an email to the user with a link they can click to execute particular actions.

GetUserCountRequestParameters

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.
GetUserGroupsRequestParameters

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

  1. Don’t specify any criteria. A stream of all groups within that realm will be returned (limited by pagination).
  2. If Search is specified, other criteria will be ignored even though you may set them.
GetUsersRequestParameters

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.