Package org.bonitasoft.web.client.api

Interface UserApi

All Superinterfaces:
ApiClient.Api
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.12.0") public interface UserApi extends ApiClient.Api

  • Method Details

    • createUser

      User createUser(UserCreateRequest body)
      Create the User Create the User
      Parameters:
      body - Partial User description (required)
      Returns:
      User

    • createUserWithHttpInfo

      ApiResponse<User> createUserWithHttpInfo(UserCreateRequest body)
      Create the User Similar to createUser but it also returns the http response headers . Create the User
      Parameters:
      body - Partial User description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • deleteUserById

      void deleteUserById(String id)
      Delete the User by ID Delete the single User for the given ID. **Use this method with caution**: some artifacts like applications, process instances or users may present display problems in the Bonita Portal if the referenced user was deleted. Note that you can disable a user instead of deleting it. To do so, use the UPDATE method and set the attribute 'enabled' to false
      Parameters:
      id - ID of the User to delete (required)

    • deleteUserByIdWithHttpInfo

      ApiResponse<Void> deleteUserByIdWithHttpInfo(String id)
      Delete the User by ID Similar to deleteUserById but it also returns the http response headers . Delete the single User for the given ID. **Use this method with caution**: some artifacts like applications, process instances or users may present display problems in the Bonita Portal if the referenced user was deleted. Note that you can disable a user instead of deleting it. To do so, use the UPDATE method and set the attribute 'enabled' to false
      Parameters:
      id - ID of the User to delete (required)

    • getUserById

      User getUserById(String id)
      Finds the User by ID Returns the single User for the given ID
      Parameters:
      id - ID of the User to return (required)
      Returns:
      User

    • getUserByIdWithHttpInfo

      ApiResponse<User> getUserByIdWithHttpInfo(String id)
      Finds the User by ID Similar to getUserById but it also returns the http response headers . Returns the single User for the given ID
      Parameters:
      id - ID of the User to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchUsers

      List<User> searchUsers(Integer p, Integer c, List<String> f, String o, String s)
      Finds Users Finds Users with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
      Parameters:
      p - index of the page to display (required)
      c - maximum number of elements to retrieve (required)
      f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
      o - can order on attributes (optional)
      s - can search on attributes (optional)
      Returns:
      List<User>

    • searchUsersWithHttpInfo

      ApiResponse<List<User>> searchUsersWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
      Finds Users Similar to searchUsers but it also returns the http response headers . Finds Users with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
      Parameters:
      p - index of the page to display (required)
      c - maximum number of elements to retrieve (required)
      f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
      o - can order on attributes (optional)
      s - can search on attributes (optional)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchUsers

      List<User> searchUsers(UserApi.SearchUsersQueryParams queryParams)
      Finds Users Finds Users with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchUsers method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the UserApi.SearchUsersQueryParams class that allows for building up this map in a fluent style.
      Parameters:
      queryParams - Map of query parameters as name-value pairs

      The following elements may be specified in the query map:

      • p - index of the page to display (required)
      • c - maximum number of elements to retrieve (required)
      • f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
      • o - can order on attributes (optional)
      • s - can search on attributes (optional)
      Returns:
      List<User>

    • searchUsersWithHttpInfo

      ApiResponse<List<User>> searchUsersWithHttpInfo(UserApi.SearchUsersQueryParams queryParams)
      Finds Users Finds Users with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchUsers that receives the query parameters as a map, but this one also exposes the Http response headers
      Parameters:
      queryParams - Map of query parameters as name-value pairs

      The following elements may be specified in the query map:

      • p - index of the page to display (required)
      • c - maximum number of elements to retrieve (required)
      • f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
      • o - can order on attributes (optional)
      • s - can search on attributes (optional)
      Returns:
      List<User>

    • updateUserById

      void updateUserById(String id, UserUpdateRequest userUpdateRequest)
      Update the User by ID Update the User for the given ID
      Parameters:
      id - ID of the User to return (required)
      userUpdateRequest - Partial User description (required)

    • updateUserByIdWithHttpInfo

      ApiResponse<Void> updateUserByIdWithHttpInfo(String id, UserUpdateRequest userUpdateRequest)
      Update the User by ID Similar to updateUserById but it also returns the http response headers . Update the User for the given ID
      Parameters:
      id - ID of the User to return (required)
      userUpdateRequest - Partial User description (required)