Package org.bremersee.keycloak.api

Interface GetUsersParameters

@Immutable public interface GetUsersParameters
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

    • getCreatedAfter

      @Nullable OffsetDateTime getCreatedAfter()
      Only return users created after (inclusive) the given date.
      Returns:
      the created after

    • getCreatedAfterAsString

      @Auxiliary default @Nullable String getCreatedAfterAsString()
      Gets created after as epoch second string.
      Returns:
      the created after as string

    • getCreatedBefore

      @Nullable OffsetDateTime getCreatedBefore()
      Only return users created before (inclusive) the given date.
      Returns:
      the created before

    • getCreatedBeforeAsString

      @Auxiliary default @Nullable String getCreatedBeforeAsString()
      Gets created before as epoch second string.
      Returns:
      the created before as string

    • getEmail

      @Nullable String getEmail()
      A String contained in email, or the complete email, if param "exact" is true.
      Returns:
      the email

    • getEmailVerified

      @Nullable Boolean getEmailVerified()
      Whether the email has been verified.
      Returns:
      the email verified

    • getEnabled

      @Nullable Boolean getEnabled()
      Boolean representing if user is enabled or not.
      Returns:
      the enabled

    • 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

    • getFirstName

      @Nullable String getFirstName()
      A String contained in firstName, or the complete firstName, if param "exact" is true.
      Returns:
      the first name

    • getIdpAlias

      @Nullable String getIdpAlias()
      The alias of an Identity Provider linked to the user.
      Returns:
      the idp alias

    • getIdpUserId

      @Nullable String getIdpUserId()
      The userId at an Identity Provider linked to the user.
      Returns:
      the idp user id

    • getLastName

      @Nullable String getLastName()
      A String contained in lastName, or the complete lastName, if param "exact" is true.
      Returns:
      the last name

    • getMax

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

    • 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

    • getUsername

      @Nullable String getUsername()
      A String contained in username, or the complete username, if param "exact" is true.
      Returns:
      the username

    • defaults

      static GetUsersParameters defaults()
      Default get user parameters.
      Returns:
      the get user parameters

    • builder

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