Package org.bremersee.keycloak.api

Interface GetGroupsParameters

@Immutable public interface GetGroupsParameters
The get user parameters.
Author:
Christian Bremer

  • Method Details

    • getBriefRepresentation

      @Nullable Boolean getBriefRepresentation()
      Boolean which defines whether brief representations are returned (default: false).
      Returns:
      the brief representation

    • getExact

      @Nullable Boolean getExact()
      Boolean which defines whether the params "last", "firstName", "email" and "username" must match exactly.
      Returns:
      the exact

    • getFirst

      @Nullable Integer getFirst()
      Gets pagination offset.
      Returns:
      the first

    • getMax

      @Nullable Integer getMax()
      Maximum results size (defaults to 100).
      Returns:
      the max

    • getPopulateHierarchy

      @Nullable Boolean getPopulateHierarchy()
      Gets populate hierarchy.
      Returns:
      the populate hierarchy

    • getQuery

      @Nullable String getQuery()
      A query to search for custom attributes, in the format 'key1:value2 key2:value2'.
      Returns:
      the query

    • getSearch

      @Nullable String getSearch()
      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.
      Returns:
      the search

    • getSubGroupsCount

      @Nullable Boolean getSubGroupsCount()
      Gets subgroups count.
      Returns:
      the subgroups count

    • defaults

      static @NonNull GetGroupsParameters defaults()
      Default get user parameters.
      Returns:
      the get user parameters

    • builder

      static GetGroupsParameters.Builder builder()
      Creates new builder.
      Returns:
      the builder