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

Class AuthorizationApi

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

  • Constructor Details

    • AuthorizationApi

      public AuthorizationApi()

    • AuthorizationApi

      public AuthorizationApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

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

    • availableOperationsAuthorization

      public ResourceOptionsDto availableOperationsAuthorization(Map<String,String> additionalHeaders) 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.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

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

    • availableOperationsAuthorizationInstance

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

    • createAuthorization

      public AuthorizationDto createAuthorization(AuthorizationCreateDto authorizationCreateDto) throws ApiException
      Create a New Authorization Creates a new authorization.
      Parameters:
      authorizationCreateDto - (optional)
      Returns:
      AuthorizationDto
      Throws:
      ApiException - if fails to make API call

    • createAuthorization

      public AuthorizationDto createAuthorization(AuthorizationCreateDto authorizationCreateDto, Map<String,String> additionalHeaders) throws ApiException
      Create a New Authorization Creates a new authorization.
      Parameters:
      authorizationCreateDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      AuthorizationDto
      Throws:
      ApiException - if fails to make API call

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

    • deleteAuthorization

      public void deleteAuthorization(String id, Map<String,String> additionalHeaders) throws ApiException
      Delete Authorization Deletes an authorization by id.
      Parameters:
      id - The id of the authorization to be deleted. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

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

    • getAuthorization

      public AuthorizationDto getAuthorization(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Authorization Retrieves an authorization by id.
      Parameters:
      id - The id of the authorization to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      AuthorizationDto
      Throws:
      ApiException - if fails to make API call

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

    • getAuthorizationCount

      public CountResultDto getAuthorizationCount(String id, Integer type, String userIdIn, String groupIdIn, Integer resourceType, String resourceId, Map<String,String> additionalHeaders) 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.21/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.21/user-guide/process-engine/authorization-service/#resources) for a list of integer representations of resource types. (optional)
      resourceId - Filter by resource id. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

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

    • isUserAuthorized

      public AuthorizationCheckResultDto isUserAuthorized(String permissionName, String resourceName, Integer resourceType, String resourceId, String userId, Map<String,String> additionalHeaders) 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      AuthorizationCheckResultDto
      Throws:
      ApiException - if fails to make API call

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

    • 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, Map<String,String> additionalHeaders) 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.21/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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<AuthorizationDto>
      Throws:
      ApiException - if fails to make API call

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

    • updateAuthorization

      public void updateAuthorization(String id, AuthorizationUpdateDto authorizationUpdateDto, Map<String,String> additionalHeaders) throws ApiException
      Update an Authorization Updates an authorization by id.
      Parameters:
      id - The id of the authorization to be updated. (required)
      authorizationUpdateDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call