Package com.pingidentity.sdk.provision.users.request

Interface ReadUsersRequestContext

All Superinterfaces:
ProvisioningRequestContext
public interface ReadUsersRequestContext extends ProvisioningRequestContext
An interface that represents the request context for a read users operation. It contains all the information needed to fulfill the request, e.g. filter.
Since:
8.0

  • Method Details

    • getFilter

      String getFilter()
      Get filter.
      Returns:
      The SCIM filter for the users to be retrieved.

    • getSortBy

      default String getSortBy()
      Get the attribute to sort by.
      Returns:
      The attributes whose value shall be used to order the returned responses.
      Since:
      8.2

    • getSortOrder

      default String getSortOrder()
      Get the sort order.
      Returns:
      The order in which the sortBy parameter is applied - either "ascending" or "descending".
      Since:
      8.2

    • getStartIndex

      default int getStartIndex()
      Get the start index of the first search result.
      Returns:
      The 1-based start index of the first search result.
      Since:
      8.2

    • getCount

      default int getCount()
      Get the desired number of maximum number of search results per page.
      Returns:
      The desired number of maximum number of search results per page.
      Since:
      8.2

    • getSCIMTargetToSourceAttributeMapping

      default AttributeMap getSCIMTargetToSourceAttributeMapping()
      Gets the map of SCIM attribute to source attributes. 
       SCIM Attributes        Identity Store Attribute
 ===============        ========================
 displayName            userName
 emails.home.value      homeEmail
 emails.work.value      workEmail
      Returns:
      The map of SCIM attribute to source attributes.
      Since:
      8.2