Package org.bonitasoft.web.client.api

Interface UserApi

All Superinterfaces:

ApiClient.Api

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public interface UserApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UserApi.SearchUsersQueryParams	A convenience class for generating query parameters for the searchUsers method in a fluent style.

Method Summary

Modifier and Type	Method	Description
User	createUser(UserCreateRequest body)	Create the User Create the User
void	deleteUserById(String id)	Delete the User by ID Delete the single User for the given ID.
User	getUserById(String id)	Finds the User by ID Returns the single User for the given ID
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`
List<User>	searchUsers(Map<String,Object> 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.
void	updateUserById(String id, UserUpdateRequest userUpdateRequest)	Update the User by ID Update the User for the given ID

Method Detail

createUser

User createUser(UserCreateRequest body)

Create the User Create the User

Parameters:

body - Partial User description (required)

Returns:

User

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)

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

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>

searchUsers

List<User> searchUsers(Map<String,Object> 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>

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)