Package com.auth0.client.mgmt.filter

Class DeviceCredentialsFilter

java.lang.Object
com.auth0.client.mgmt.filter.BaseFilter
com.auth0.client.mgmt.filter.FieldsFilter
com.auth0.client.mgmt.filter.DeviceCredentialsFilter
public class DeviceCredentialsFilter extends FieldsFilter
Class used to filter the results received when calling the Device Credentials endpoint. Related to the DeviceCredentialsEntity entity.

This class is not thread-safe.

See Also:

  • Constructor Details

    • DeviceCredentialsFilter

      public DeviceCredentialsFilter()

  • Method Details

    • withUserId

      public DeviceCredentialsFilter withUserId(String userId)
      Filter by user id
      Parameters:
      userId - only retrieve items with this user id.
      Returns:
      this filter instance.

    • withClientId

      public DeviceCredentialsFilter withClientId(String clientId)
      Filter by application's client id
      Parameters:
      clientId - only retrieve items with this client id.
      Returns:
      this filter instance.

    • withType

      public DeviceCredentialsFilter withType(String type)
      Filter by type
      Parameters:
      type - only retrieve items with this type.
      Returns:
      this filter instance.

    • withFields

      public DeviceCredentialsFilter 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

    • withPage

      public DeviceCredentialsFilter 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

    • withTotals

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