Package com.auth0.client.mgmt.filter

Class ClientFilter

java.lang.Object
com.auth0.client.mgmt.filter.BaseFilter
com.auth0.client.mgmt.filter.FieldsFilter
com.auth0.client.mgmt.filter.ClientFilter
public class ClientFilter extends FieldsFilter
Class used to filter the results received when calling the Clients endpoint. Related to the ClientsEntity entity.

This class is not thread-safe.

See Also:

  • Constructor Details

    • ClientFilter

      public ClientFilter()

  • Method Details

    • withTotals

      public ClientFilter withTotals(boolean includeTotals)
      Include the query summary
      Parameters:
      includeTotals - whether to include or not the query summary.
      Returns:
      this filter instance

    • withPage

      public ClientFilter withPage(int pageNumber, int amountPerPage)
      Filter by page
      Parameters:
      pageNumber - the page number to retrieve.
      amountPerPage - the amount of items per page to retrieve.
      Returns:
      this filter instance

    • withIsGlobal

      public ClientFilter withIsGlobal(boolean isGlobal)
      Filter by global clients
      Parameters:
      isGlobal - whether the client should or not be global
      Returns:
      this filter instance

    • withIsFirstParty

      public ClientFilter withIsFirstParty(boolean isFirstParty)
      Filter by first party clients
      Parameters:
      isFirstParty - whether the client should or not be first party
      Returns:
      this filter instance

    • withAppType

      public ClientFilter withAppType(String appType)
      Filter by application type
      Parameters:
      appType - A comma separated list of application types used to filter the returned clients (native, spa, regular_web, non_interactive)
      Returns:
      this filter instance

    • withFields

      public ClientFilter withFields(String fields, boolean includeFields)
      Description copied from class: FieldsFilter
      Only retrieve certain fields from the item.
      Overrides:
      withFields in class FieldsFilter
      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