Package com.auth0.client.mgmt.filter

Class UserFilter

java.lang.Object
com.auth0.client.mgmt.filter.BaseFilter
com.auth0.client.mgmt.filter.FieldsFilter
com.auth0.client.mgmt.filter.QueryFilter
com.auth0.client.mgmt.filter.UserFilter
public class UserFilter extends QueryFilter
Class used to filter the results received when calling the Users endpoint. Related to the UsersEntity entity.

This class is not thread-safe.

See Also:

  • Constructor Details

    • UserFilter

      public UserFilter()
      Creates a new instance using the latest search engine version.

      Since version 1.12.0 this SDK no longer specifies a search engine version by default. If you need to use a version different than the latest one, please set it explicitly by calling withSearchEngine(String). See the latest user search doc: https://auth0.com/docs/users/search/

  • Method Details

    • withTotals

      public UserFilter withTotals(boolean includeTotals)
      Description copied from class: QueryFilter
      Include the query summary
      Overrides:
      withTotals in class QueryFilter
      Parameters:
      includeTotals - whether to include or not the query summary.
      Returns:
      this filter instance

    • withSearchEngine

      public UserFilter withSearchEngine(String searchEngineVersion)
      Selects which Search Engine version to use when querying for users.

      See the latest user search doc: https://auth0.com/docs/users/search/

      Parameters:
      searchEngineVersion - the search engine version to use on queries.
      Returns:
      this filter instance

    • withQuery

      public UserFilter withQuery(String query)
      Filter by a query
      Overrides:
      withQuery in class QueryFilter
      Parameters:
      query - the query expression to use following the syntax defined at https://auth0.com/docs/users/search/v3/query-syntax
      Returns:
      this filter instance

    • withSort

      public UserFilter withSort(String sort)
      Description copied from class: QueryFilter
      Sort the query
      Overrides:
      withSort in class QueryFilter
      Parameters:
      sort - the field to use for sorting. Use 'field:order' where order is 1 for ascending and -1 for descending.
      Returns:
      this filter instance

    • withPage

      public UserFilter withPage(int pageNumber, int amountPerPage)
      Description copied from class: QueryFilter
      Filter by page
      Overrides:
      withPage in class QueryFilter
      Parameters:
      pageNumber - the page number to retrieve.
      amountPerPage - the amount of items per page to retrieve.
      Returns:
      this filter instance

    • withFields

      public UserFilter withFields(String fields, boolean includeFields)
      Description copied from class: FieldsFilter
      Only retrieve certain fields from the item.
      Overrides:
      withFields in class QueryFilter
      Parameters:
      fields - a list of comma separated fields to retrieve.
      includeFields - whether to include or exclude in the response the fields that were given.
      Returns:
      this filter instance

    • withConnection

      public UserFilter withConnection(String connection)
      Connection filter. Only applies when using search_engine=v1. To filter by connection with search_engine=v2|v3, use q=identities.connection:"connection_name"
      Parameters:
      connection - connection to be filtered with
      Returns:
      this filter instance