Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Camunda Platform REST API
* OpenApi Spec for Camunda Platform REST API.
*
* The version of the OpenAPI document: 7.19.0-alpha1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package org.openapitools.client.api;
import org.openapitools.client.ApiCallback;
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.ApiResponse;
import org.openapitools.client.Configuration;
import org.openapitools.client.Pair;
import org.openapitools.client.ProgressRequestBody;
import org.openapitools.client.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import org.openapitools.client.model.CountResultDto;
import org.openapitools.client.model.ExceptionDto;
import org.openapitools.client.model.ResourceOptionsDto;
import org.openapitools.client.model.UserCredentialsDto;
import org.openapitools.client.model.UserDto;
import org.openapitools.client.model.UserProfileDto;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class UserApi {
private ApiClient localVarApiClient;
public UserApi() {
this(Configuration.getDefaultApiClient());
}
public UserApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
/**
* Build call for availableOperations
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
*/
public okhttp3.Call availableOperationsCall(final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/user";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "OPTIONS", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call availableOperationsValidateBeforeCall(final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = availableOperationsCall(_callback);
return localVarCall;
}
/**
* 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.
* @return ResourceOptionsDto
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
*/
public ResourceOptionsDto availableOperations() throws ApiException {
ApiResponse localVarResp = availableOperationsWithHttpInfo();
return localVarResp.getData();
}
/**
* 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.
* @return ApiResponse<ResourceOptionsDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
*/
public ApiResponse availableOperationsWithHttpInfo() throws ApiException {
okhttp3.Call localVarCall = availableOperationsValidateBeforeCall(null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Options (asynchronously)
* 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.
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
*/
public okhttp3.Call availableOperationsAsync(final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = availableOperationsValidateBeforeCall(_callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for availableUserOperations
* @param id The id of the user to be deleted. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
*/
public okhttp3.Call availableUserOperationsCall(String id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/user/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "OPTIONS", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call availableUserOperationsValidateBeforeCall(String id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling availableUserOperations(Async)");
}
okhttp3.Call localVarCall = availableUserOperationsCall(id, _callback);
return localVarCall;
}
/**
* 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.
* @param id The id of the user to be deleted. (required)
* @return ResourceOptionsDto
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
*/
public ResourceOptionsDto availableUserOperations(String id) throws ApiException {
ApiResponse localVarResp = availableUserOperationsWithHttpInfo(id);
return localVarResp.getData();
}
/**
* 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.
* @param id The id of the user to be deleted. (required)
* @return ApiResponse<ResourceOptionsDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
*/
public ApiResponse availableUserOperationsWithHttpInfo(String id) throws ApiException {
okhttp3.Call localVarCall = availableUserOperationsValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Options (asynchronously)
* 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.
* @param id The id of the user to be deleted. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
*/
public okhttp3.Call availableUserOperationsAsync(String id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = availableUserOperationsValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for createUser
* @param userDto (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
*/
public okhttp3.Call createUserCall(UserDto userDto, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = userDto;
// create path and map variables
String localVarPath = "/user/create";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createUserValidateBeforeCall(UserDto userDto, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createUserCall(userDto, _callback);
return localVarCall;
}
/**
* Create
* Create a new user.
* @param userDto (optional)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
*/
public void createUser(UserDto userDto) throws ApiException {
createUserWithHttpInfo(userDto);
}
/**
* Create
* Create a new user.
* @param userDto (optional)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
*/
public ApiResponse createUserWithHttpInfo(UserDto userDto) throws ApiException {
okhttp3.Call localVarCall = createUserValidateBeforeCall(userDto, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Create (asynchronously)
* Create a new user.
* @param userDto (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
*/
public okhttp3.Call createUserAsync(UserDto userDto, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createUserValidateBeforeCall(userDto, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for deleteUser
* @param id The id of the user to be deleted. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
404
A Deployment with the provided id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call deleteUserCall(String id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/user/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteUserValidateBeforeCall(String id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling deleteUser(Async)");
}
okhttp3.Call localVarCall = deleteUserCall(id, _callback);
return localVarCall;
}
/**
* Delete
* Deletes a user by id.
* @param id The id of the user to be deleted. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
404
A Deployment with the provided id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public void deleteUser(String id) throws ApiException {
deleteUserWithHttpInfo(id);
}
/**
* Delete
* Deletes a user by id.
* @param id The id of the user to be deleted. (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
404
A Deployment with the provided id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse deleteUserWithHttpInfo(String id) throws ApiException {
okhttp3.Call localVarCall = deleteUserValidateBeforeCall(id, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Delete (asynchronously)
* Deletes a user by id.
* @param id The id of the user to be deleted. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
404
A Deployment with the provided id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call deleteUserAsync(String id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteUserValidateBeforeCall(id, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for getUserCount
* @param id Filter by user id (optional)
* @param idIn Filter by a comma-separated list of user ids. (optional)
* @param firstName Filter by the first name of the user. Exact match. (optional)
* @param firstNameLike Filter by the first name that the parameter is a substring of. (optional)
* @param lastName Filter by the last name of the user. Exact match. (optional)
* @param lastNameLike Filter by the last name that the parameter is a substring of. (optional)
* @param email Filter by the email of the user. Exact match. (optional)
* @param emailLike Filter by the email that the parameter is a substring of. (optional)
* @param memberOfGroup Filter for users which are members of the given group. (optional)
* @param memberOfTenant Filter for users which are members of the given tenant. (optional)
* @param potentialStarter Only select Users that are potential starter for the given process definition. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example, if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getUserCountCall(String id, String idIn, String firstName, String firstNameLike, String lastName, String lastNameLike, String email, String emailLike, String memberOfGroup, String memberOfTenant, String potentialStarter, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/user/count";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (id != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("id", id));
}
if (idIn != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("idIn", idIn));
}
if (firstName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("firstName", firstName));
}
if (firstNameLike != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("firstNameLike", firstNameLike));
}
if (lastName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("lastName", lastName));
}
if (lastNameLike != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("lastNameLike", lastNameLike));
}
if (email != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("email", email));
}
if (emailLike != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("emailLike", emailLike));
}
if (memberOfGroup != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("memberOfGroup", memberOfGroup));
}
if (memberOfTenant != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("memberOfTenant", memberOfTenant));
}
if (potentialStarter != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("potentialStarter", potentialStarter));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getUserCountValidateBeforeCall(String id, String idIn, String firstName, String firstNameLike, String lastName, String lastNameLike, String email, String emailLike, String memberOfGroup, String memberOfTenant, String potentialStarter, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getUserCountCall(id, idIn, firstName, firstNameLike, lastName, lastNameLike, email, emailLike, memberOfGroup, memberOfTenant, potentialStarter, _callback);
return localVarCall;
}
/**
* 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/latest/reference/rest/user/get-query/) method.
* @param id Filter by user id (optional)
* @param idIn Filter by a comma-separated list of user ids. (optional)
* @param firstName Filter by the first name of the user. Exact match. (optional)
* @param firstNameLike Filter by the first name that the parameter is a substring of. (optional)
* @param lastName Filter by the last name of the user. Exact match. (optional)
* @param lastNameLike Filter by the last name that the parameter is a substring of. (optional)
* @param email Filter by the email of the user. Exact match. (optional)
* @param emailLike Filter by the email that the parameter is a substring of. (optional)
* @param memberOfGroup Filter for users which are members of the given group. (optional)
* @param memberOfTenant Filter for users which are members of the given tenant. (optional)
* @param potentialStarter Only select Users that are potential starter for the given process definition. (optional)
* @return CountResultDto
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example, if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
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 {
ApiResponse localVarResp = getUserCountWithHttpInfo(id, idIn, firstName, firstNameLike, lastName, lastNameLike, email, emailLike, memberOfGroup, memberOfTenant, potentialStarter);
return localVarResp.getData();
}
/**
* 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/latest/reference/rest/user/get-query/) method.
* @param id Filter by user id (optional)
* @param idIn Filter by a comma-separated list of user ids. (optional)
* @param firstName Filter by the first name of the user. Exact match. (optional)
* @param firstNameLike Filter by the first name that the parameter is a substring of. (optional)
* @param lastName Filter by the last name of the user. Exact match. (optional)
* @param lastNameLike Filter by the last name that the parameter is a substring of. (optional)
* @param email Filter by the email of the user. Exact match. (optional)
* @param emailLike Filter by the email that the parameter is a substring of. (optional)
* @param memberOfGroup Filter for users which are members of the given group. (optional)
* @param memberOfTenant Filter for users which are members of the given tenant. (optional)
* @param potentialStarter Only select Users that are potential starter for the given process definition. (optional)
* @return ApiResponse<CountResultDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example, if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse getUserCountWithHttpInfo(String id, String idIn, String firstName, String firstNameLike, String lastName, String lastNameLike, String email, String emailLike, String memberOfGroup, String memberOfTenant, String potentialStarter) throws ApiException {
okhttp3.Call localVarCall = getUserCountValidateBeforeCall(id, idIn, firstName, firstNameLike, lastName, lastNameLike, email, emailLike, memberOfGroup, memberOfTenant, potentialStarter, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get List Count (asynchronously)
* Queries for the number of deployments that fulfill given parameters. Takes the same parameters as the [Get Users](https://docs.camunda.org/manual/latest/reference/rest/user/get-query/) method.
* @param id Filter by user id (optional)
* @param idIn Filter by a comma-separated list of user ids. (optional)
* @param firstName Filter by the first name of the user. Exact match. (optional)
* @param firstNameLike Filter by the first name that the parameter is a substring of. (optional)
* @param lastName Filter by the last name of the user. Exact match. (optional)
* @param lastNameLike Filter by the last name that the parameter is a substring of. (optional)
* @param email Filter by the email of the user. Exact match. (optional)
* @param emailLike Filter by the email that the parameter is a substring of. (optional)
* @param memberOfGroup Filter for users which are members of the given group. (optional)
* @param memberOfTenant Filter for users which are members of the given tenant. (optional)
* @param potentialStarter Only select Users that are potential starter for the given process definition. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example, if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getUserCountAsync(String id, String idIn, String firstName, String firstNameLike, String lastName, String lastNameLike, String email, String emailLike, String memberOfGroup, String memberOfTenant, String potentialStarter, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getUserCountValidateBeforeCall(id, idIn, firstName, firstNameLike, lastName, lastNameLike, email, emailLike, memberOfGroup, memberOfTenant, potentialStarter, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getUserProfile
* @param id The id of the user to retrieve. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Execution with given id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getUserProfileCall(String id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/user/{id}/profile"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getUserProfileValidateBeforeCall(String id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getUserProfile(Async)");
}
okhttp3.Call localVarCall = getUserProfileCall(id, _callback);
return localVarCall;
}
/**
* Get Profile
* Retrieves a user's profile.
* @param id The id of the user to retrieve. (required)
* @return UserProfileDto
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Execution with given id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public UserProfileDto getUserProfile(String id) throws ApiException {
ApiResponse localVarResp = getUserProfileWithHttpInfo(id);
return localVarResp.getData();
}
/**
* Get Profile
* Retrieves a user's profile.
* @param id The id of the user to retrieve. (required)
* @return ApiResponse<UserProfileDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Execution with given id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse getUserProfileWithHttpInfo(String id) throws ApiException {
okhttp3.Call localVarCall = getUserProfileValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get Profile (asynchronously)
* Retrieves a user's profile.
* @param id The id of the user to retrieve. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
404
Execution with given id does not exist. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getUserProfileAsync(String id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getUserProfileValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getUsers
* @param id Filter by user id (optional)
* @param idIn Filter by a comma-separated list of user ids. (optional)
* @param firstName Filter by the first name of the user. Exact match. (optional)
* @param firstNameLike Filter by the first name that the parameter is a substring of. (optional)
* @param lastName Filter by the last name of the user. Exact match. (optional)
* @param lastNameLike Filter by the last name that the parameter is a substring of. (optional)
* @param email Filter by the email of the user. Exact match. (optional)
* @param emailLike Filter by the email that the parameter is a substring of. (optional)
* @param memberOfGroup Filter for users which are members of the given group. (optional)
* @param memberOfTenant Filter for users which are members of the given tenant. (optional)
* @param potentialStarter Only select Users that are potential starter for the given process definition. (optional)
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param 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)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getUsersCall(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, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/user";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
if (id != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("id", id));
}
if (idIn != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("idIn", idIn));
}
if (firstName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("firstName", firstName));
}
if (firstNameLike != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("firstNameLike", firstNameLike));
}
if (lastName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("lastName", lastName));
}
if (lastNameLike != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("lastNameLike", lastNameLike));
}
if (email != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("email", email));
}
if (emailLike != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("emailLike", emailLike));
}
if (memberOfGroup != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("memberOfGroup", memberOfGroup));
}
if (memberOfTenant != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("memberOfTenant", memberOfTenant));
}
if (potentialStarter != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("potentialStarter", potentialStarter));
}
if (sortBy != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sortBy", sortBy));
}
if (sortOrder != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sortOrder", sortOrder));
}
if (firstResult != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("firstResult", firstResult));
}
if (maxResults != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxResults", maxResults));
}
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getUsersValidateBeforeCall(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, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getUsersCall(id, idIn, firstName, firstNameLike, lastName, lastNameLike, email, emailLike, memberOfGroup, memberOfTenant, potentialStarter, sortBy, sortOrder, firstResult, maxResults, _callback);
return localVarCall;
}
/**
* 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/latest/reference/rest/user/get-query-count/) method.
* @param id Filter by user id (optional)
* @param idIn Filter by a comma-separated list of user ids. (optional)
* @param firstName Filter by the first name of the user. Exact match. (optional)
* @param firstNameLike Filter by the first name that the parameter is a substring of. (optional)
* @param lastName Filter by the last name of the user. Exact match. (optional)
* @param lastNameLike Filter by the last name that the parameter is a substring of. (optional)
* @param email Filter by the email of the user. Exact match. (optional)
* @param emailLike Filter by the email that the parameter is a substring of. (optional)
* @param memberOfGroup Filter for users which are members of the given group. (optional)
* @param memberOfTenant Filter for users which are members of the given tenant. (optional)
* @param potentialStarter Only select Users that are potential starter for the given process definition. (optional)
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param 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)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @return List<UserProfileDto>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public List 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 {
ApiResponse> localVarResp = getUsersWithHttpInfo(id, idIn, firstName, firstNameLike, lastName, lastNameLike, email, emailLike, memberOfGroup, memberOfTenant, potentialStarter, sortBy, sortOrder, firstResult, maxResults);
return localVarResp.getData();
}
/**
* 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/latest/reference/rest/user/get-query-count/) method.
* @param id Filter by user id (optional)
* @param idIn Filter by a comma-separated list of user ids. (optional)
* @param firstName Filter by the first name of the user. Exact match. (optional)
* @param firstNameLike Filter by the first name that the parameter is a substring of. (optional)
* @param lastName Filter by the last name of the user. Exact match. (optional)
* @param lastNameLike Filter by the last name that the parameter is a substring of. (optional)
* @param email Filter by the email of the user. Exact match. (optional)
* @param emailLike Filter by the email that the parameter is a substring of. (optional)
* @param memberOfGroup Filter for users which are members of the given group. (optional)
* @param memberOfTenant Filter for users which are members of the given tenant. (optional)
* @param potentialStarter Only select Users that are potential starter for the given process definition. (optional)
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param 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)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @return ApiResponse<List<UserProfileDto>>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse> getUsersWithHttpInfo(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 {
okhttp3.Call localVarCall = getUsersValidateBeforeCall(id, idIn, firstName, firstNameLike, lastName, lastNameLike, email, emailLike, memberOfGroup, memberOfTenant, potentialStarter, sortBy, sortOrder, firstResult, maxResults, null);
Type localVarReturnType = new TypeToken>(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* Get List (asynchronously)
* 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/latest/reference/rest/user/get-query-count/) method.
* @param id Filter by user id (optional)
* @param idIn Filter by a comma-separated list of user ids. (optional)
* @param firstName Filter by the first name of the user. Exact match. (optional)
* @param firstNameLike Filter by the first name that the parameter is a substring of. (optional)
* @param lastName Filter by the last name of the user. Exact match. (optional)
* @param lastNameLike Filter by the last name that the parameter is a substring of. (optional)
* @param email Filter by the email of the user. Exact match. (optional)
* @param emailLike Filter by the email that the parameter is a substring of. (optional)
* @param memberOfGroup Filter for users which are members of the given group. (optional)
* @param memberOfTenant Filter for users which are members of the given tenant. (optional)
* @param potentialStarter Only select Users that are potential starter for the given process definition. (optional)
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param 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)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Request successful.
-
400
Returned if some of the query parameters are invalid, for example if a `sortOrder` parameter is supplied, but no `sortBy`, or if an invalid operator for variable comparison is used. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call getUsersAsync(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, final ApiCallback> _callback) throws ApiException {
okhttp3.Call localVarCall = getUsersValidateBeforeCall(id, idIn, firstName, firstNameLike, lastName, lastNameLike, email, emailLike, memberOfGroup, memberOfTenant, potentialStarter, sortBy, sortOrder, firstResult, maxResults, _callback);
Type localVarReturnType = new TypeToken>(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for unlockUser
* @param id The id of the user to be unlocked. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
403
The user who performed the operation is not a Camunda admin user.
-
404
User cannot be found. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call unlockUserCall(String id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/user/{id}/unlock"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call unlockUserValidateBeforeCall(String id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling unlockUser(Async)");
}
okhttp3.Call localVarCall = unlockUserCall(id, _callback);
return localVarCall;
}
/**
* Unlock User
* Unlocks a user by id.
* @param id The id of the user to be unlocked. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
403
The user who performed the operation is not a Camunda admin user.
-
404
User cannot be found. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public void unlockUser(String id) throws ApiException {
unlockUserWithHttpInfo(id);
}
/**
* Unlock User
* Unlocks a user by id.
* @param id The id of the user to be unlocked. (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
403
The user who performed the operation is not a Camunda admin user.
-
404
User cannot be found. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse unlockUserWithHttpInfo(String id) throws ApiException {
okhttp3.Call localVarCall = unlockUserValidateBeforeCall(id, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Unlock User (asynchronously)
* Unlocks a user by id.
* @param id The id of the user to be unlocked. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful.
-
403
The user who performed the operation is not a Camunda admin user.
-
404
User cannot be found. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call unlockUserAsync(String id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = unlockUserValidateBeforeCall(id, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for updateCredentials
* @param id The id of the user to be updated. (required)
* @param userCredentialsDto (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful. This method returns no content.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
400
The authenticated user password does not match
-
404
If the corresponding user cannot be found
-
500
The user could not be updated due to an internal server error. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call updateCredentialsCall(String id, UserCredentialsDto userCredentialsDto, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = userCredentialsDto;
// create path and map variables
String localVarPath = "/user/{id}/credentials"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call updateCredentialsValidateBeforeCall(String id, UserCredentialsDto userCredentialsDto, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling updateCredentials(Async)");
}
okhttp3.Call localVarCall = updateCredentialsCall(id, userCredentialsDto, _callback);
return localVarCall;
}
/**
* Update Credentials
* Updates a user's credentials (password)
* @param id The id of the user to be updated. (required)
* @param userCredentialsDto (optional)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful. This method returns no content.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
400
The authenticated user password does not match
-
404
If the corresponding user cannot be found
-
500
The user could not be updated due to an internal server error. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public void updateCredentials(String id, UserCredentialsDto userCredentialsDto) throws ApiException {
updateCredentialsWithHttpInfo(id, userCredentialsDto);
}
/**
* Update Credentials
* Updates a user's credentials (password)
* @param id The id of the user to be updated. (required)
* @param userCredentialsDto (optional)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful. This method returns no content.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
400
The authenticated user password does not match
-
404
If the corresponding user cannot be found
-
500
The user could not be updated due to an internal server error. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse updateCredentialsWithHttpInfo(String id, UserCredentialsDto userCredentialsDto) throws ApiException {
okhttp3.Call localVarCall = updateCredentialsValidateBeforeCall(id, userCredentialsDto, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Update Credentials (asynchronously)
* Updates a user's credentials (password)
* @param id The id of the user to be updated. (required)
* @param userCredentialsDto (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful. This method returns no content.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
400
The authenticated user password does not match
-
404
If the corresponding user cannot be found
-
500
The user could not be updated due to an internal server error. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call updateCredentialsAsync(String id, UserCredentialsDto userCredentialsDto, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = updateCredentialsValidateBeforeCall(id, userCredentialsDto, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for updateProfile
* @param id The id of the user. (required)
* @param userProfileDto (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful. This method returns no content.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
404
If the user with the requested Id cannot be found.
-
500
The user could not be updated due to an internal server error. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public okhttp3.Call updateProfileCall(String id, UserProfileDto userProfileDto, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = userProfileDto;
// create path and map variables
String localVarPath = "/user/{id}/profile"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "basicAuth" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call updateProfileValidateBeforeCall(String id, UserProfileDto userProfileDto, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling updateProfile(Async)");
}
okhttp3.Call localVarCall = updateProfileCall(id, userProfileDto, _callback);
return localVarCall;
}
/**
* Update User Profile
* Updates the profile information of an already existing user.
* @param id The id of the user. (required)
* @param userProfileDto (optional)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful. This method returns no content.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
404
If the user with the requested Id cannot be found.
-
500
The user could not be updated due to an internal server error. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public void updateProfile(String id, UserProfileDto userProfileDto) throws ApiException {
updateProfileWithHttpInfo(id, userProfileDto);
}
/**
* Update User Profile
* Updates the profile information of an already existing user.
* @param id The id of the user. (required)
* @param userProfileDto (optional)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
Request successful. This method returns no content.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
404
If the user with the requested Id cannot be found.
-
500
The user could not be updated due to an internal server error. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
-
*/
public ApiResponse updateProfileWithHttpInfo(String id, UserProfileDto userProfileDto) throws ApiException {
okhttp3.Call localVarCall = updateProfileValidateBeforeCall(id, userProfileDto, null);
return localVarApiClient.execute(localVarCall);
}
/**
* Update User Profile (asynchronously)
* Updates the profile information of an already existing user.
* @param id The id of the user. (required)
* @param userProfileDto (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
204
Request successful. This method returns no content.
-
403
Identity service is read-only (Cannot modify users / groups / memberships).
-
404
If the user with the requested Id cannot be found.
-
500
The user could not be updated due to an internal server error. See the [Introduction](https://docs.camunda.org/manual/latest/reference/rest/overview/#error-handling) for the error response format.
