org.openapitools.client.api

Class IdentityApi

java.lang.Object

org.openapitools.client.api.IdentityApi

public class IdentityApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IdentityApi()
IdentityApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CheckPasswordPolicyResultDto	checkPassword(PasswordPolicyRequestDto passwordPolicyRequestDto) Validate Password A password policy consists of a list of rules that new passwords must follow to be policy compliant.
okhttp3.Call	checkPasswordAsync(PasswordPolicyRequestDto passwordPolicyRequestDto, ApiCallback<CheckPasswordPolicyResultDto> _callback) Validate Password (asynchronously) A password policy consists of a list of rules that new passwords must follow to be policy compliant.
okhttp3.Call	checkPasswordCall(PasswordPolicyRequestDto passwordPolicyRequestDto, ApiCallback _callback) Build call for checkPassword
ApiResponse<CheckPasswordPolicyResultDto>	checkPasswordWithHttpInfo(PasswordPolicyRequestDto passwordPolicyRequestDto) Validate Password A password policy consists of a list of rules that new passwords must follow to be policy compliant.
ApiClient	getApiClient()
IdentityServiceGroupInfoDto	getGroupInfo(String userId) Get a User's Groups Gets the groups of a user by id and includes all users that share a group with the given user.
okhttp3.Call	getGroupInfoAsync(String userId, ApiCallback<IdentityServiceGroupInfoDto> _callback) Get a User's Groups (asynchronously) Gets the groups of a user by id and includes all users that share a group with the given user.
okhttp3.Call	getGroupInfoCall(String userId, ApiCallback _callback) Build call for getGroupInfo
ApiResponse<IdentityServiceGroupInfoDto>	getGroupInfoWithHttpInfo(String userId) Get a User's Groups Gets the groups of a user by id and includes all users that share a group with the given user.
PasswordPolicyDto	getPasswordPolicy() Get Password Policy A password policy consists of a list of rules that new passwords must follow to be policy compliant.
okhttp3.Call	getPasswordPolicyAsync(ApiCallback<PasswordPolicyDto> _callback) Get Password Policy (asynchronously) A password policy consists of a list of rules that new passwords must follow to be policy compliant.
okhttp3.Call	getPasswordPolicyCall(ApiCallback _callback) Build call for getPasswordPolicy
ApiResponse<PasswordPolicyDto>	getPasswordPolicyWithHttpInfo() Get Password Policy A password policy consists of a list of rules that new passwords must follow to be policy compliant.
void	setApiClient(ApiClient apiClient)
AuthenticationResult	verifyUser(BasicUserCredentialsDto basicUserCredentialsDto) Verify User Verifies that user credentials are valid.
okhttp3.Call	verifyUserAsync(BasicUserCredentialsDto basicUserCredentialsDto, ApiCallback<AuthenticationResult> _callback) Verify User (asynchronously) Verifies that user credentials are valid.
okhttp3.Call	verifyUserCall(BasicUserCredentialsDto basicUserCredentialsDto, ApiCallback _callback) Build call for verifyUser
ApiResponse<AuthenticationResult>	verifyUserWithHttpInfo(BasicUserCredentialsDto basicUserCredentialsDto) Verify User Verifies that user credentials are valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityApi

public IdentityApi()

IdentityApi

public IdentityApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

checkPasswordCall

public okhttp3.Call checkPasswordCall(PasswordPolicyRequestDto passwordPolicyRequestDto,
                                      ApiCallback _callback)
                               throws ApiException

Build call for checkPassword

Parameters:

passwordPolicyRequestDto - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

checkPassword

public CheckPasswordPolicyResultDto checkPassword(PasswordPolicyRequestDto passwordPolicyRequestDto)
                                           throws ApiException

Validate Password A password policy consists of a list of rules that new passwords must follow to be policy compliant. A password can be checked for compliancy via this end point. More information on password policies in Camunda can be found in the password policy [user guide](https://docs.camunda.org/manual/7.15/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.15/user-guide/security/).

Parameters:

passwordPolicyRequestDto - (optional)

Returns:

CheckPasswordPolicyResultDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

checkPasswordWithHttpInfo

public ApiResponse<CheckPasswordPolicyResultDto> checkPasswordWithHttpInfo(PasswordPolicyRequestDto passwordPolicyRequestDto)
                                                                    throws ApiException

Validate Password A password policy consists of a list of rules that new passwords must follow to be policy compliant. A password can be checked for compliancy via this end point. More information on password policies in Camunda can be found in the password policy [user guide](https://docs.camunda.org/manual/7.15/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.15/user-guide/security/).

Parameters:

passwordPolicyRequestDto - (optional)

Returns:

ApiResponse<CheckPasswordPolicyResultDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

checkPasswordAsync

public okhttp3.Call checkPasswordAsync(PasswordPolicyRequestDto passwordPolicyRequestDto,
                                       ApiCallback<CheckPasswordPolicyResultDto> _callback)
                                throws ApiException

Validate Password (asynchronously) A password policy consists of a list of rules that new passwords must follow to be policy compliant. A password can be checked for compliancy via this end point. More information on password policies in Camunda can be found in the password policy [user guide](https://docs.camunda.org/manual/7.15/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.15/user-guide/security/).

Parameters:

passwordPolicyRequestDto - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getGroupInfoCall

public okhttp3.Call getGroupInfoCall(String userId,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getGroupInfo

Parameters:

userId - The id of the user to get the groups for. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getGroupInfo

public IdentityServiceGroupInfoDto getGroupInfo(String userId)
                                         throws ApiException

Get a User's Groups Gets the groups of a user by id and includes all users that share a group with the given user.

Parameters:

userId - The id of the user to get the groups for. (required)

Returns:

IdentityServiceGroupInfoDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getGroupInfoWithHttpInfo

public ApiResponse<IdentityServiceGroupInfoDto> getGroupInfoWithHttpInfo(String userId)
                                                                  throws ApiException

Get a User's Groups Gets the groups of a user by id and includes all users that share a group with the given user.

Parameters:

userId - The id of the user to get the groups for. (required)

Returns:

ApiResponse<IdentityServiceGroupInfoDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getGroupInfoAsync

public okhttp3.Call getGroupInfoAsync(String userId,
                                      ApiCallback<IdentityServiceGroupInfoDto> _callback)
                               throws ApiException

Get a User's Groups (asynchronously) Gets the groups of a user by id and includes all users that share a group with the given user.

Parameters:

userId - The id of the user to get the groups for. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getPasswordPolicyCall

public okhttp3.Call getPasswordPolicyCall(ApiCallback _callback)
                                   throws ApiException

Build call for getPasswordPolicy

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPasswordPolicy

public PasswordPolicyDto getPasswordPolicy()
                                    throws ApiException

Get Password Policy A password policy consists of a list of rules that new passwords must follow to be policy compliant. This end point returns a JSON representation of the list of policy rules. More information on password policies in Camunda can be found in the password policy [user guide](https://docs.camunda.org/manual/7.15/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.15/user-guide/security/).

Returns:

PasswordPolicyDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPasswordPolicyWithHttpInfo

public ApiResponse<PasswordPolicyDto> getPasswordPolicyWithHttpInfo()
                                                             throws ApiException

Get Password Policy A password policy consists of a list of rules that new passwords must follow to be policy compliant. This end point returns a JSON representation of the list of policy rules. More information on password policies in Camunda can be found in the password policy [user guide](https://docs.camunda.org/manual/7.15/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.15/user-guide/security/).

Returns:

ApiResponse<PasswordPolicyDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getPasswordPolicyAsync

public okhttp3.Call getPasswordPolicyAsync(ApiCallback<PasswordPolicyDto> _callback)
                                    throws ApiException

Get Password Policy (asynchronously) A password policy consists of a list of rules that new passwords must follow to be policy compliant. This end point returns a JSON representation of the list of policy rules. More information on password policies in Camunda can be found in the password policy [user guide](https://docs.camunda.org/manual/7.15/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.15/user-guide/security/).

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

verifyUserCall

public okhttp3.Call verifyUserCall(BasicUserCredentialsDto basicUserCredentialsDto,
                                   ApiCallback _callback)
                            throws ApiException

Build call for verifyUser

Parameters:

basicUserCredentialsDto - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

verifyUser

public AuthenticationResult verifyUser(BasicUserCredentialsDto basicUserCredentialsDto)
                                throws ApiException

Verify User Verifies that user credentials are valid.

Parameters:

basicUserCredentialsDto - (optional)

Returns:

AuthenticationResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

verifyUserWithHttpInfo

public ApiResponse<AuthenticationResult> verifyUserWithHttpInfo(BasicUserCredentialsDto basicUserCredentialsDto)
                                                         throws ApiException

Verify User Verifies that user credentials are valid.

Parameters:

basicUserCredentialsDto - (optional)

Returns:

ApiResponse<AuthenticationResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

verifyUserAsync

public okhttp3.Call verifyUserAsync(BasicUserCredentialsDto basicUserCredentialsDto,
                                    ApiCallback<AuthenticationResult> _callback)
                             throws ApiException

Verify User (asynchronously) Verifies that user credentials are valid.

Parameters:

basicUserCredentialsDto - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object