Package org.openapitools.client.api

Class AuthorizationApi

  • public class AuthorizationApi
extends Object

    • Constructor Detail

      • AuthorizationApi

        public AuthorizationApi()

      • AuthorizationApi

        public AuthorizationApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • availableOperationsAuthorizationCall

        public okhttp3.Call availableOperationsAuthorizationCall​(ApiCallback _callback)
                                                  throws ApiException
        Build call for availableOperationsAuthorization
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • availableOperationsAuthorization

        public ResourceOptionsDto availableOperationsAuthorization()
                                                    throws ApiException
        Authorization Resource Options The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on the `/authorization` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
        Returns:
        ResourceOptionsDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableOperationsAuthorizationWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableOperationsAuthorizationWithHttpInfo()
                                                                             throws ApiException
        Authorization Resource Options The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on the `/authorization` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
        Returns:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableOperationsAuthorizationAsync

        public okhttp3.Call availableOperationsAuthorizationAsync​(ApiCallback<ResourceOptionsDto> _callback)
                                                   throws ApiException
        Authorization Resource Options (asynchronously) The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on the `/authorization` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
        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

      • availableOperationsAuthorizationInstanceCall

        public okhttp3.Call availableOperationsAuthorizationInstanceCall​(String id,
                                                                 ApiCallback _callback)
                                                          throws ApiException
        Build call for availableOperationsAuthorizationInstance
        Parameters:
        id - The id of the authorization to be retrieved. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • availableOperationsAuthorizationInstance

        public ResourceOptionsDto availableOperationsAuthorizationInstance​(String id)
                                                            throws ApiException
        Authorization Resource Options The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on a given instance of the `/authorization` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
        Parameters:
        id - The id of the authorization to be retrieved. (required)
        Returns:
        ResourceOptionsDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableOperationsAuthorizationInstanceWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableOperationsAuthorizationInstanceWithHttpInfo​(String id)
                                                                                     throws ApiException
        Authorization Resource Options The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on a given instance of the `/authorization` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
        Parameters:
        id - The id of the authorization to be retrieved. (required)
        Returns:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableOperationsAuthorizationInstanceAsync

        public okhttp3.Call availableOperationsAuthorizationInstanceAsync​(String id,
                                                                  ApiCallback<ResourceOptionsDto> _callback)
                                                           throws ApiException
        Authorization Resource Options (asynchronously) The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on a given instance of the `/authorization` resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.
        Parameters:
        id - The id of the authorization to be retrieved. (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

      • createAuthorizationCall

        public okhttp3.Call createAuthorizationCall​(AuthorizationCreateDto authorizationCreateDto,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for createAuthorization
        Parameters:
        authorizationCreateDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createAuthorization

        public AuthorizationDto createAuthorization​(AuthorizationCreateDto authorizationCreateDto)
                                     throws ApiException
        Create a New Authorization Creates a new authorization.
        Parameters:
        authorizationCreateDto - (optional)
        Returns:
        AuthorizationDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createAuthorizationWithHttpInfo

        public ApiResponse<AuthorizationDto> createAuthorizationWithHttpInfo​(AuthorizationCreateDto authorizationCreateDto)
                                                              throws ApiException
        Create a New Authorization Creates a new authorization.
        Parameters:
        authorizationCreateDto - (optional)
        Returns:
        ApiResponse<AuthorizationDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createAuthorizationAsync

        public okhttp3.Call createAuthorizationAsync​(AuthorizationCreateDto authorizationCreateDto,
                                             ApiCallback<AuthorizationDto> _callback)
                                      throws ApiException
        Create a New Authorization (asynchronously) Creates a new authorization.
        Parameters:
        authorizationCreateDto - (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

      • deleteAuthorizationCall

        public okhttp3.Call deleteAuthorizationCall​(String id,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for deleteAuthorization
        Parameters:
        id - The id of the authorization to be deleted. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteAuthorization

        public void deleteAuthorization​(String id)
                         throws ApiException
        Delete Authorization Deletes an authorization by id.
        Parameters:
        id - The id of the authorization to be deleted. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteAuthorizationWithHttpInfo

        public ApiResponse<Void> deleteAuthorizationWithHttpInfo​(String id)
                                                  throws ApiException
        Delete Authorization Deletes an authorization by id.
        Parameters:
        id - The id of the authorization to be deleted. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteAuthorizationAsync

        public okhttp3.Call deleteAuthorizationAsync​(String id,
                                             ApiCallback<Void> _callback)
                                      throws ApiException
        Delete Authorization (asynchronously) Deletes an authorization by id.
        Parameters:
        id - The id of the authorization to be deleted. (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

      • getAuthorizationCall

        public okhttp3.Call getAuthorizationCall​(String id,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for getAuthorization
        Parameters:
        id - The id of the authorization to be retrieved. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getAuthorization

        public AuthorizationDto getAuthorization​(String id)
                                  throws ApiException
        Get Authorization Retrieves an authorization by id.
        Parameters:
        id - The id of the authorization to be retrieved. (required)
        Returns:
        AuthorizationDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAuthorizationWithHttpInfo

        public ApiResponse<AuthorizationDto> getAuthorizationWithHttpInfo​(String id)
                                                           throws ApiException
        Get Authorization Retrieves an authorization by id.
        Parameters:
        id - The id of the authorization to be retrieved. (required)
        Returns:
        ApiResponse<AuthorizationDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAuthorizationAsync

        public okhttp3.Call getAuthorizationAsync​(String id,
                                          ApiCallback<AuthorizationDto> _callback)
                                   throws ApiException
        Get Authorization (asynchronously) Retrieves an authorization by id.
        Parameters:
        id - The id of the authorization to be retrieved. (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

      • getAuthorizationCountCall

        public okhttp3.Call getAuthorizationCountCall​(String id,
                                              Integer type,
                                              String userIdIn,
                                              String groupIdIn,
                                              Integer resourceType,
                                              String resourceId,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for getAuthorizationCount
        Parameters:
        id - Filter by the id of the authorization. (optional)
        type - Filter by authorization type. (0=global, 1=grant, 2=revoke). See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#authorization-type) for more information about authorization types. (optional)
        userIdIn - Filter by a comma-separated list of userIds. (optional)
        groupIdIn - Filter by a comma-separated list of groupIds. (optional)
        resourceType - Filter by an integer representation of the resource type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (optional)
        resourceId - Filter by resource id. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getAuthorizationCount

        public CountResultDto getAuthorizationCount​(String id,
                                            Integer type,
                                            String userIdIn,
                                            String groupIdIn,
                                            Integer resourceType,
                                            String resourceId)
                                     throws ApiException
        Get Authorization Count Queries for authorizations using a list of parameters and retrieves the count.
        Parameters:
        id - Filter by the id of the authorization. (optional)
        type - Filter by authorization type. (0=global, 1=grant, 2=revoke). See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#authorization-type) for more information about authorization types. (optional)
        userIdIn - Filter by a comma-separated list of userIds. (optional)
        groupIdIn - Filter by a comma-separated list of groupIds. (optional)
        resourceType - Filter by an integer representation of the resource type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (optional)
        resourceId - Filter by resource id. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAuthorizationCountWithHttpInfo

        public ApiResponse<CountResultDto> getAuthorizationCountWithHttpInfo​(String id,
                                                                     Integer type,
                                                                     String userIdIn,
                                                                     String groupIdIn,
                                                                     Integer resourceType,
                                                                     String resourceId)
                                                              throws ApiException
        Get Authorization Count Queries for authorizations using a list of parameters and retrieves the count.
        Parameters:
        id - Filter by the id of the authorization. (optional)
        type - Filter by authorization type. (0=global, 1=grant, 2=revoke). See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#authorization-type) for more information about authorization types. (optional)
        userIdIn - Filter by a comma-separated list of userIds. (optional)
        groupIdIn - Filter by a comma-separated list of groupIds. (optional)
        resourceType - Filter by an integer representation of the resource type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (optional)
        resourceId - Filter by resource id. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAuthorizationCountAsync

        public okhttp3.Call getAuthorizationCountAsync​(String id,
                                               Integer type,
                                               String userIdIn,
                                               String groupIdIn,
                                               Integer resourceType,
                                               String resourceId,
                                               ApiCallback<CountResultDto> _callback)
                                        throws ApiException
        Get Authorization Count (asynchronously) Queries for authorizations using a list of parameters and retrieves the count.
        Parameters:
        id - Filter by the id of the authorization. (optional)
        type - Filter by authorization type. (0=global, 1=grant, 2=revoke). See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#authorization-type) for more information about authorization types. (optional)
        userIdIn - Filter by a comma-separated list of userIds. (optional)
        groupIdIn - Filter by a comma-separated list of groupIds. (optional)
        resourceType - Filter by an integer representation of the resource type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (optional)
        resourceId - Filter by resource id. (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

      • isUserAuthorizedCall

        public okhttp3.Call isUserAuthorizedCall​(String permissionName,
                                         String resourceName,
                                         Integer resourceType,
                                         String resourceId,
                                         String userId,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for isUserAuthorized
        Parameters:
        permissionName - String value representing the permission name to check for. (required)
        resourceName - String value for the name of the resource to check permissions for. (required)
        resourceType - An integer representing the resource type to check permissions for. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (required)
        resourceId - The id of the resource to check permissions for. If left blank, a check for global permissions on the resource is performed. (optional)
        userId - The id of the user to check permissions for. The currently authenticated user must have a READ permission for the Authorization resource. If `userId` is blank, a check for the currently authenticated user is performed. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • isUserAuthorized

        public AuthorizationCheckResultDto isUserAuthorized​(String permissionName,
                                                    String resourceName,
                                                    Integer resourceType,
                                                    String resourceId,
                                                    String userId)
                                             throws ApiException
        Perform an Authorization Check Performs an authorization check for the currently authenticated user.
        Parameters:
        permissionName - String value representing the permission name to check for. (required)
        resourceName - String value for the name of the resource to check permissions for. (required)
        resourceType - An integer representing the resource type to check permissions for. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (required)
        resourceId - The id of the resource to check permissions for. If left blank, a check for global permissions on the resource is performed. (optional)
        userId - The id of the user to check permissions for. The currently authenticated user must have a READ permission for the Authorization resource. If `userId` is blank, a check for the currently authenticated user is performed. (optional)
        Returns:
        AuthorizationCheckResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • isUserAuthorizedWithHttpInfo

        public ApiResponse<AuthorizationCheckResultDto> isUserAuthorizedWithHttpInfo​(String permissionName,
                                                                             String resourceName,
                                                                             Integer resourceType,
                                                                             String resourceId,
                                                                             String userId)
                                                                      throws ApiException
        Perform an Authorization Check Performs an authorization check for the currently authenticated user.
        Parameters:
        permissionName - String value representing the permission name to check for. (required)
        resourceName - String value for the name of the resource to check permissions for. (required)
        resourceType - An integer representing the resource type to check permissions for. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (required)
        resourceId - The id of the resource to check permissions for. If left blank, a check for global permissions on the resource is performed. (optional)
        userId - The id of the user to check permissions for. The currently authenticated user must have a READ permission for the Authorization resource. If `userId` is blank, a check for the currently authenticated user is performed. (optional)
        Returns:
        ApiResponse<AuthorizationCheckResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • isUserAuthorizedAsync

        public okhttp3.Call isUserAuthorizedAsync​(String permissionName,
                                          String resourceName,
                                          Integer resourceType,
                                          String resourceId,
                                          String userId,
                                          ApiCallback<AuthorizationCheckResultDto> _callback)
                                   throws ApiException
        Perform an Authorization Check (asynchronously) Performs an authorization check for the currently authenticated user.
        Parameters:
        permissionName - String value representing the permission name to check for. (required)
        resourceName - String value for the name of the resource to check permissions for. (required)
        resourceType - An integer representing the resource type to check permissions for. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (required)
        resourceId - The id of the resource to check permissions for. If left blank, a check for global permissions on the resource is performed. (optional)
        userId - The id of the user to check permissions for. The currently authenticated user must have a READ permission for the Authorization resource. If `userId` is blank, a check for the currently authenticated user is performed. (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

      • queryAuthorizationsCall

        public okhttp3.Call queryAuthorizationsCall​(String id,
                                            Integer type,
                                            String userIdIn,
                                            String groupIdIn,
                                            Integer resourceType,
                                            String resourceId,
                                            String sortBy,
                                            String sortOrder,
                                            Integer firstResult,
                                            Integer maxResults,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for queryAuthorizations
        Parameters:
        id - Filter by the id of the authorization. (optional)
        type - Filter by authorization type. (0=global, 1=grant, 2=revoke). See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#authorization-type) for more information about authorization types. (optional)
        userIdIn - Filter by a comma-separated list of userIds. (optional)
        groupIdIn - Filter by a comma-separated list of groupIds. (optional)
        resourceType - Filter by an integer representation of the resource type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (optional)
        resourceId - Filter by resource id. (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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • queryAuthorizations

        public List<AuthorizationDto> queryAuthorizations​(String id,
                                                  Integer type,
                                                  String userIdIn,
                                                  String groupIdIn,
                                                  Integer resourceType,
                                                  String resourceId,
                                                  String sortBy,
                                                  String sortOrder,
                                                  Integer firstResult,
                                                  Integer maxResults)
                                           throws ApiException
        Get Authorizations Queries for a list of authorizations using a list of parameters. The size of the result set can be retrieved by using the [Get Authorization Count](https://docs.camunda.org/manual/7.18/reference/rest/authorization/get-query-count/) method.
        Parameters:
        id - Filter by the id of the authorization. (optional)
        type - Filter by authorization type. (0=global, 1=grant, 2=revoke). See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#authorization-type) for more information about authorization types. (optional)
        userIdIn - Filter by a comma-separated list of userIds. (optional)
        groupIdIn - Filter by a comma-separated list of groupIds. (optional)
        resourceType - Filter by an integer representation of the resource type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (optional)
        resourceId - Filter by resource id. (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<AuthorizationDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryAuthorizationsWithHttpInfo

        public ApiResponse<List<AuthorizationDto>> queryAuthorizationsWithHttpInfo​(String id,
                                                                           Integer type,
                                                                           String userIdIn,
                                                                           String groupIdIn,
                                                                           Integer resourceType,
                                                                           String resourceId,
                                                                           String sortBy,
                                                                           String sortOrder,
                                                                           Integer firstResult,
                                                                           Integer maxResults)
                                                                    throws ApiException
        Get Authorizations Queries for a list of authorizations using a list of parameters. The size of the result set can be retrieved by using the [Get Authorization Count](https://docs.camunda.org/manual/7.18/reference/rest/authorization/get-query-count/) method.
        Parameters:
        id - Filter by the id of the authorization. (optional)
        type - Filter by authorization type. (0=global, 1=grant, 2=revoke). See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#authorization-type) for more information about authorization types. (optional)
        userIdIn - Filter by a comma-separated list of userIds. (optional)
        groupIdIn - Filter by a comma-separated list of groupIds. (optional)
        resourceType - Filter by an integer representation of the resource type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (optional)
        resourceId - Filter by resource id. (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:
        ApiResponse<List<AuthorizationDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryAuthorizationsAsync

        public okhttp3.Call queryAuthorizationsAsync​(String id,
                                             Integer type,
                                             String userIdIn,
                                             String groupIdIn,
                                             Integer resourceType,
                                             String resourceId,
                                             String sortBy,
                                             String sortOrder,
                                             Integer firstResult,
                                             Integer maxResults,
                                             ApiCallback<List<AuthorizationDto>> _callback)
                                      throws ApiException
        Get Authorizations (asynchronously) Queries for a list of authorizations using a list of parameters. The size of the result set can be retrieved by using the [Get Authorization Count](https://docs.camunda.org/manual/7.18/reference/rest/authorization/get-query-count/) method.
        Parameters:
        id - Filter by the id of the authorization. (optional)
        type - Filter by authorization type. (0=global, 1=grant, 2=revoke). See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#authorization-type) for more information about authorization types. (optional)
        userIdIn - Filter by a comma-separated list of userIds. (optional)
        groupIdIn - Filter by a comma-separated list of groupIds. (optional)
        resourceType - Filter by an integer representation of the resource type. See the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (optional)
        resourceId - Filter by resource id. (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)
        _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

      • updateAuthorizationCall

        public okhttp3.Call updateAuthorizationCall​(String id,
                                            AuthorizationUpdateDto authorizationUpdateDto,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for updateAuthorization
        Parameters:
        id - The id of the authorization to be updated. (required)
        authorizationUpdateDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateAuthorization

        public void updateAuthorization​(String id,
                                AuthorizationUpdateDto authorizationUpdateDto)
                         throws ApiException
        Update an Authorization Updates an authorization by id.
        Parameters:
        id - The id of the authorization to be updated. (required)
        authorizationUpdateDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateAuthorizationWithHttpInfo

        public ApiResponse<Void> updateAuthorizationWithHttpInfo​(String id,
                                                         AuthorizationUpdateDto authorizationUpdateDto)
                                                  throws ApiException
        Update an Authorization Updates an authorization by id.
        Parameters:
        id - The id of the authorization to be updated. (required)
        authorizationUpdateDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateAuthorizationAsync

        public okhttp3.Call updateAuthorizationAsync​(String id,
                                             AuthorizationUpdateDto authorizationUpdateDto,
                                             ApiCallback<Void> _callback)
                                      throws ApiException
        Update an Authorization (asynchronously) Updates an authorization by id.
        Parameters:
        id - The id of the authorization to be updated. (required)
        authorizationUpdateDto - (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