Package io.camunda.identity.sdk.users

Interface Users

All Known Implementing Classes:
UsersImpl
public interface Users
The Users class provides functionality to retrieve the users stored in the Camunda Identity instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Users
    create(IdentityConfiguration configuration, Authentication authentication)
    Factory function to create a new users instance
    List<User>
    get(List<String> userIds)
    Returns the list of users which match the userIds passed in.
    boolean
    isAvailable()
    Returns a true/false indicating if the search is available or not.
    List<User>
    search(String search)
    Returns the list of users which match the search string passed in.
    List<User>
    search(String search, Integer page)
    Returns the list of users which match the search string passed in, found on the page requested.
    List<User>
    search(String search, Integer page, Integer resultSize)
    Returns the list of users which match the search string passed in, found on the page requested with the maximum number of results defined by result size.
    Users
    withAccessToken(String accessToken)
    All calls performed with the returned Users instance will be made using given access token

  • Method Details

    • withAccessToken

      Users withAccessToken(String accessToken)
      All calls performed with the returned Users instance will be made using given access token
      Parameters:
      accessToken - access token
      Returns:
      Users instance

    • search

      List<User> search(String search)
      Returns the list of users which match the search string passed in.
      Parameters:
      search - the search string
      Returns:
      the list of users

    • search

      List<User> search(String search, Integer page)
      Returns the list of users which match the search string passed in, found on the page requested.
      Parameters:
      search - the search string
      page - the page of results
      Returns:
      the list of users

    • search

      List<User> search(String search, Integer page, Integer resultSize)
      Returns the list of users which match the search string passed in, found on the page requested with the maximum number of results defined by result size.
      Parameters:
      search - the search string
      page - the page of results
      resultSize - the amount of results per page
      Returns:
      the list of users

    • get

      List<User> get(List<String> userIds)
      Returns the list of users which match the userIds passed in.
      Parameters:
      userIds - the userIds
      Returns:
      the list of users

    • isAvailable

      boolean isAvailable()
      Returns a true/false indicating if the search is available or not.
      Returns:
      the availability of search

    • create

      static Users create(IdentityConfiguration configuration, Authentication authentication)
      Factory function to create a new users instance
      Parameters:
      configuration - Identity configuration
      authentication - Identity Authentication
      Returns:
      Users instance