Table of Contents

Class GetUserGroupsRequestParameters

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

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.
public class GetUserGroupsRequestParameters
Inheritance
GetUserGroupsRequestParameters
Inherited Members

Properties

BriefRepresentation

Defines whether brief representations are returned. Default is false.

public bool? BriefRepresentation { get; init; }

Property Value

bool?

First

Pagination offset.

public int? First { get; init; }

Property Value

int?

Max

Maximum results size. Default is 100.

public int? Max { get; init; }

Property Value

int?

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

public string? Search { get; init; }

Property Value

string