Package org.camunda.community.rest.client.api

Class UserApi

java.lang.Object

org.camunda.community.rest.client.api.UserApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-04T13:43:01.451833574Z[Etc/UTC]")
public class UserApi
extends Object

Constructor Summary

Constructors

Constructor	Description
UserApi()
UserApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ResourceOptionsDto	availableOperations()	Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances.
ResourceOptionsDto	availableOperations(Map<String,String> additionalHeaders)	Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances.
ResourceOptionsDto	availableUserOperations(String id)	Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances.
ResourceOptionsDto	availableUserOperations(String id, Map<String,String> additionalHeaders)	Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances.
void	createUser(UserDto userDto)	Create Create a new user.
void	createUser(UserDto userDto, Map<String,String> additionalHeaders)	Create Create a new user.
void	deleteUser(String id)	Delete Deletes a user by id.
void	deleteUser(String id, Map<String,String> additionalHeaders)	Delete Deletes a user by id.
ApiClient	getApiClient()
CountResultDto	getUserCount(String id, String idIn, String firstName, String firstNameLike, String lastName, String lastNameLike, String email, String emailLike, String memberOfGroup, String memberOfTenant, String potentialStarter)	Get List Count Queries for the number of deployments that fulfill given parameters.
CountResultDto	getUserCount(String id, String idIn, String firstName, String firstNameLike, String lastName, String lastNameLike, String email, String emailLike, String memberOfGroup, String memberOfTenant, String potentialStarter, Map<String,String> additionalHeaders)	Get List Count Queries for the number of deployments that fulfill given parameters.
UserProfileDto	getUserProfile(String id)	Get Profile Retrieves a user's profile.
UserProfileDto	getUserProfile(String id, Map<String,String> additionalHeaders)	Get Profile Retrieves a user's profile.
List<UserProfileDto>	getUsers(String id, String idIn, String firstName, String firstNameLike, String lastName, String lastNameLike, String email, String emailLike, String memberOfGroup, String memberOfTenant, String potentialStarter, String sortBy, String sortOrder, Integer firstResult, Integer maxResults)	Get List Query for a list of users using a list of parameters.
List<UserProfileDto>	getUsers(String id, String idIn, String firstName, String firstNameLike, String lastName, String lastNameLike, String email, String emailLike, String memberOfGroup, String memberOfTenant, String potentialStarter, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders)	Get List Query for a list of users using a list of parameters.
void	setApiClient(ApiClient apiClient)
void	unlockUser(String id)	Unlock User Unlocks a user by id.
void	unlockUser(String id, Map<String,String> additionalHeaders)	Unlock User Unlocks a user by id.
void	updateCredentials(String id, UserCredentialsDto userCredentialsDto)	Update Credentials Updates a user's credentials (password)
void	updateCredentials(String id, UserCredentialsDto userCredentialsDto, Map<String,String> additionalHeaders)	Update Credentials Updates a user's credentials (password)
void	updateProfile(String id, UserProfileDto userProfileDto)	Update User Profile Updates the profile information of an already existing user.
void	updateProfile(String id, UserProfileDto userProfileDto, Map<String,String> additionalHeaders)	Update User Profile Updates the profile information of an already existing user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserApi

public UserApi()

UserApi

public UserApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

availableOperations

public ResourceOptionsDto availableOperations()
                                       throws ApiException

Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user` returns available interactions on the resource.

Returns:

ResourceOptionsDto

Throws:

ApiException - if fails to make API call

availableOperations

public ResourceOptionsDto availableOperations(Map<String,String> additionalHeaders)
                                       throws ApiException

Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user` returns available interactions on the resource.

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

ResourceOptionsDto

Throws:

ApiException - if fails to make API call

availableUserOperations

public ResourceOptionsDto availableUserOperations(String id)
                                           throws ApiException

Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user/{id}` returns available interactions on a resource instance.

Parameters:

id - The id of the user to be deleted. (required)

Returns:

ResourceOptionsDto

Throws:

ApiException - if fails to make API call

availableUserOperations

public ResourceOptionsDto availableUserOperations(String id,
 Map<String,String> additionalHeaders)
                                           throws ApiException

Options The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances. The `OPTIONS` request allows checking for the set of available operations that the currently authenticated user can perform on the /user resource. If the user can perform an operation or not may depend on various things, including the user's authorizations to interact with this resource and the internal configuration of the process engine. `OPTIONS /user/{id}` returns available interactions on a resource instance.

Parameters:

id - The id of the user to be deleted. (required)

additionalHeaders - additionalHeaders for this call

Returns:

ResourceOptionsDto

Throws:

ApiException - if fails to make API call

createUser

public void createUser(UserDto userDto)
                throws ApiException

Create Create a new user.

Parameters:

userDto - (optional)

Throws:

ApiException - if fails to make API call

createUser

public void createUser(UserDto userDto,
 Map<String,String> additionalHeaders)
                throws ApiException

Create Create a new user.

Parameters:

userDto - (optional)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteUser

public void deleteUser(String id)
                throws ApiException

Delete Deletes a user by id.

Parameters:

id - The id of the user to be deleted. (required)

Throws:

ApiException - if fails to make API call

deleteUser

public void deleteUser(String id,
 Map<String,String> additionalHeaders)
                throws ApiException

Delete Deletes a user by id.

Parameters:

id - The id of the user to be deleted. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getUserCount

public CountResultDto getUserCount(String id,
 String idIn,
 String firstName,
 String firstNameLike,
 String lastName,
 String lastNameLike,
 String email,
 String emailLike,
 String memberOfGroup,
 String memberOfTenant,
 String potentialStarter)
                            throws ApiException

Get List Count Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Users](https://docs.camunda.org/manual/7.21/reference/rest/user/get-query/) method.

Parameters:

id - Filter by user id (optional)

idIn - Filter by a comma-separated list of user ids. (optional)

firstName - Filter by the first name of the user. Exact match. (optional)

firstNameLike - Filter by the first name that the parameter is a substring of. (optional)

lastName - Filter by the last name of the user. Exact match. (optional)

lastNameLike - Filter by the last name that the parameter is a substring of. (optional)

email - Filter by the email of the user. Exact match. (optional)

emailLike - Filter by the email that the parameter is a substring of. (optional)

memberOfGroup - Filter for users which are members of the given group. (optional)

memberOfTenant - Filter for users which are members of the given tenant. (optional)

potentialStarter - Only select Users that are potential starter for the given process definition. (optional)

Returns:

CountResultDto

Throws:

ApiException - if fails to make API call

getUserCount

public CountResultDto getUserCount(String id,
 String idIn,
 String firstName,
 String firstNameLike,
 String lastName,
 String lastNameLike,
 String email,
 String emailLike,
 String memberOfGroup,
 String memberOfTenant,
 String potentialStarter,
 Map<String,String> additionalHeaders)
                            throws ApiException

Get List Count Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Users](https://docs.camunda.org/manual/7.21/reference/rest/user/get-query/) method.

Parameters:

id - Filter by user id (optional)

idIn - Filter by a comma-separated list of user ids. (optional)

firstName - Filter by the first name of the user. Exact match. (optional)

firstNameLike - Filter by the first name that the parameter is a substring of. (optional)

lastName - Filter by the last name of the user. Exact match. (optional)

lastNameLike - Filter by the last name that the parameter is a substring of. (optional)

email - Filter by the email of the user. Exact match. (optional)

emailLike - Filter by the email that the parameter is a substring of. (optional)

memberOfGroup - Filter for users which are members of the given group. (optional)

memberOfTenant - Filter for users which are members of the given tenant. (optional)

potentialStarter - Only select Users that are potential starter for the given process definition. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

CountResultDto

Throws:

ApiException - if fails to make API call

getUserProfile

public UserProfileDto getUserProfile(String id)
                              throws ApiException

Get Profile Retrieves a user's profile.

Parameters:

id - The id of the user to retrieve. (required)

Returns:

UserProfileDto

Throws:

ApiException - if fails to make API call

getUserProfile

public UserProfileDto getUserProfile(String id,
 Map<String,String> additionalHeaders)
                              throws ApiException

Get Profile Retrieves a user's profile.

Parameters:

id - The id of the user to retrieve. (required)

additionalHeaders - additionalHeaders for this call

Returns:

UserProfileDto

Throws:

ApiException - if fails to make API call

getUsers

public List<UserProfileDto> getUsers(String id,
 String idIn,
 String firstName,
 String firstNameLike,
 String lastName,
 String lastNameLike,
 String email,
 String emailLike,
 String memberOfGroup,
 String memberOfTenant,
 String potentialStarter,
 String sortBy,
 String sortOrder,
 Integer firstResult,
 Integer maxResults)
                              throws ApiException

Get List Query for a list of users using a list of parameters. The size of the result set can be retrieved by using the Get User Count method. [Get User Count](https://docs.camunda.org/manual/7.21/reference/rest/user/get-query-count/) method.

Parameters:

id - Filter by user id (optional)

idIn - Filter by a comma-separated list of user ids. (optional)

firstName - Filter by the first name of the user. Exact match. (optional)

firstNameLike - Filter by the first name that the parameter is a substring of. (optional)

lastName - Filter by the last name of the user. Exact match. (optional)

lastNameLike - Filter by the last name that the parameter is a substring of. (optional)

email - Filter by the email of the user. Exact match. (optional)

emailLike - Filter by the email that the parameter is a substring of. (optional)

memberOfGroup - Filter for users which are members of the given group. (optional)

memberOfTenant - Filter for users which are members of the given tenant. (optional)

potentialStarter - Only select Users that are potential starter for the given process definition. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

Returns:

List<UserProfileDto>

Throws:

ApiException - if fails to make API call

getUsers

public List<UserProfileDto> getUsers(String id,
 String idIn,
 String firstName,
 String firstNameLike,
 String lastName,
 String lastNameLike,
 String email,
 String emailLike,
 String memberOfGroup,
 String memberOfTenant,
 String potentialStarter,
 String sortBy,
 String sortOrder,
 Integer firstResult,
 Integer maxResults,
 Map<String,String> additionalHeaders)
                              throws ApiException

Get List Query for a list of users using a list of parameters. The size of the result set can be retrieved by using the Get User Count method. [Get User Count](https://docs.camunda.org/manual/7.21/reference/rest/user/get-query-count/) method.

Parameters:

id - Filter by user id (optional)

idIn - Filter by a comma-separated list of user ids. (optional)

firstName - Filter by the first name of the user. Exact match. (optional)

firstNameLike - Filter by the first name that the parameter is a substring of. (optional)

lastName - Filter by the last name of the user. Exact match. (optional)

lastNameLike - Filter by the last name that the parameter is a substring of. (optional)

email - Filter by the email of the user. Exact match. (optional)

emailLike - Filter by the email that the parameter is a substring of. (optional)

memberOfGroup - Filter for users which are members of the given group. (optional)

memberOfTenant - Filter for users which are members of the given tenant. (optional)

potentialStarter - Only select Users that are potential starter for the given process definition. (optional)

sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)

sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)

firstResult - Pagination of results. Specifies the index of the first result to return. (optional)

maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<UserProfileDto>

Throws:

ApiException - if fails to make API call

unlockUser

public void unlockUser(String id)
                throws ApiException

Unlock User Unlocks a user by id.

Parameters:

id - The id of the user to be unlocked. (required)

Throws:

ApiException - if fails to make API call

unlockUser

public void unlockUser(String id,
 Map<String,String> additionalHeaders)
                throws ApiException

Unlock User Unlocks a user by id.

Parameters:

id - The id of the user to be unlocked. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

updateCredentials

public void updateCredentials(String id,
 UserCredentialsDto userCredentialsDto)
                       throws ApiException

Update Credentials Updates a user's credentials (password)

Parameters:

id - The id of the user to be updated. (required)

userCredentialsDto - (optional)

Throws:

ApiException - if fails to make API call

updateCredentials

public void updateCredentials(String id,
 UserCredentialsDto userCredentialsDto,
 Map<String,String> additionalHeaders)
                       throws ApiException

Update Credentials Updates a user's credentials (password)

Parameters:

id - The id of the user to be updated. (required)

userCredentialsDto - (optional)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

updateProfile

public void updateProfile(String id,
 UserProfileDto userProfileDto)
                   throws ApiException

Update User Profile Updates the profile information of an already existing user.

Parameters:

id - The id of the user. (required)

userProfileDto - (optional)

Throws:

ApiException - if fails to make API call

updateProfile

public void updateProfile(String id,
 UserProfileDto userProfileDto,
 Map<String,String> additionalHeaders)
                   throws ApiException

Update User Profile Updates the profile information of an already existing user.

Parameters:

id - The id of the user. (required)

userProfileDto - (optional)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call