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

Class IdentityApi

java.lang.Object
org.camunda.community.rest.client.api.IdentityApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class IdentityApi extends Object

  • Constructor Details

    • IdentityApi

      public IdentityApi()

    • IdentityApi

      public IdentityApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • 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.21/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.21/user-guide/security/).
      Parameters:
      passwordPolicyRequestDto - (optional)
      Returns:
      CheckPasswordPolicyResultDto
      Throws:
      ApiException - if fails to make API call

    • checkPassword

      public CheckPasswordPolicyResultDto checkPassword(PasswordPolicyRequestDto passwordPolicyRequestDto, Map<String,String> additionalHeaders) 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.21/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.21/user-guide/security/).
      Parameters:
      passwordPolicyRequestDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CheckPasswordPolicyResultDto
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • getGroupInfo

      public IdentityServiceGroupInfoDto getGroupInfo(String userId, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityServiceGroupInfoDto
      Throws:
      ApiException - if fails to make API call

    • 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.21/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.21/user-guide/security/).
      Returns:
      PasswordPolicyDto
      Throws:
      ApiException - if fails to make API call

    • getPasswordPolicy

      public PasswordPolicyDto getPasswordPolicy(Map<String,String> additionalHeaders) 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.21/user-guide/process-engine/password-policy/) and in the [security instructions](https://docs.camunda.org/manual/7.21/user-guide/security/).
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      PasswordPolicyDto
      Throws:
      ApiException - if fails to make API call

    • verifyUser

      public AuthenticationResult verifyUser(BasicUserCredentialsDto basicUserCredentialsDto) throws ApiException
      Verify User Verifies that user credentials are valid.
      Parameters:
      basicUserCredentialsDto - (optional)
      Returns:
      AuthenticationResult
      Throws:
      ApiException - if fails to make API call

    • verifyUser

      public AuthenticationResult verifyUser(BasicUserCredentialsDto basicUserCredentialsDto, Map<String,String> additionalHeaders) throws ApiException
      Verify User Verifies that user credentials are valid.
      Parameters:
      basicUserCredentialsDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      AuthenticationResult
      Throws:
      ApiException - if fails to make API call