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

Class TenantApi

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

  • Constructor Details

    • TenantApi

      public TenantApi()

    • TenantApi

      public TenantApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • availableTenantGroupMembersOperations

      public ResourceOptionsDto availableTenantGroupMembersOperations(String id) throws ApiException
      Tenant Group Membership Resource Options The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the tenant (required)
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableTenantGroupMembersOperations

      public ResourceOptionsDto availableTenantGroupMembersOperations(String id, Map<String,String> additionalHeaders) throws ApiException
      Tenant Group Membership Resource Options The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the tenant (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableTenantInstanceOperations

      public ResourceOptionsDto availableTenantInstanceOperations(String id) throws ApiException
      Tenant Resource Options The `/tenant` resource supports two custom OPTIONS requests, one for the resource as such and this one for individual tenant instances. The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the `/tenant/{id}` resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the tenant (required)
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableTenantInstanceOperations

      public ResourceOptionsDto availableTenantInstanceOperations(String id, Map<String,String> additionalHeaders) throws ApiException
      Tenant Resource Options The `/tenant` resource supports two custom OPTIONS requests, one for the resource as such and this one for individual tenant instances. The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the `/tenant/{id}` resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the tenant (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableTenantResourceOperations

      public ResourceOptionsDto availableTenantResourceOperations() throws ApiException
      Tenant Resource Options The `/tenant` resource supports two custom OPTIONS requests, this one for the resource as such and one for individual tenant instances. The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the `/tenant` resource. If the user can perform an operation or not may depend on various things, 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

    • availableTenantResourceOperations

      public ResourceOptionsDto availableTenantResourceOperations(Map<String,String> additionalHeaders) throws ApiException
      Tenant Resource Options The `/tenant` resource supports two custom OPTIONS requests, this one for the resource as such and one for individual tenant instances. The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the `/tenant` resource. If the user can perform an operation or not may depend on various things, 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

    • availableTenantUserMembersOperations

      public ResourceOptionsDto availableTenantUserMembersOperations(String id) throws ApiException
      Tenant User Membership Resource Options The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the tenant (required)
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableTenantUserMembersOperations

      public ResourceOptionsDto availableTenantUserMembersOperations(String id, Map<String,String> additionalHeaders) throws ApiException
      Tenant User Membership Resource Options The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the tenant (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • createGroupMembership

      public void createGroupMembership(String id, String groupId) throws ApiException
      Create Tenant Group Membership Creates a membership between a tenant and a group.
      Parameters:
      id - The id of the tenant. (required)
      groupId - The id of the group. (required)
      Throws:
      ApiException - if fails to make API call

    • createGroupMembership

      public void createGroupMembership(String id, String groupId, Map<String,String> additionalHeaders) throws ApiException
      Create Tenant Group Membership Creates a membership between a tenant and a group.
      Parameters:
      id - The id of the tenant. (required)
      groupId - The id of the group. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • createTenant

      public void createTenant(TenantDto tenantDto) throws ApiException
      Create Tenant Create a new tenant.
      Parameters:
      tenantDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • createTenant

      public void createTenant(TenantDto tenantDto, Map<String,String> additionalHeaders) throws ApiException
      Create Tenant Create a new tenant.
      Parameters:
      tenantDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • createUserMembership

      public void createUserMembership(String id, String userId) throws ApiException
      Create Tenant User Membership Creates a membership between a tenant and an user.
      Parameters:
      id - The id of the tenant. (required)
      userId - The id of the user. (required)
      Throws:
      ApiException - if fails to make API call

    • createUserMembership

      public void createUserMembership(String id, String userId, Map<String,String> additionalHeaders) throws ApiException
      Create Tenant User Membership Creates a membership between a tenant and an user.
      Parameters:
      id - The id of the tenant. (required)
      userId - The id of the user. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteGroupMembership

      public void deleteGroupMembership(String id, String groupId) throws ApiException
      Create Tenant Group Membership Creates a membership between a tenant and a group.
      Parameters:
      id - The id of the tenant. (required)
      groupId - The id of the group. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteGroupMembership

      public void deleteGroupMembership(String id, String groupId, Map<String,String> additionalHeaders) throws ApiException
      Create Tenant Group Membership Creates a membership between a tenant and a group.
      Parameters:
      id - The id of the tenant. (required)
      groupId - The id of the group. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteTenant

      public void deleteTenant(String id) throws ApiException
      Delete Tenant Deletes a tenant by id.
      Parameters:
      id - The id of the tenant to be deleted. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteTenant

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

    • deleteUserMembership

      public void deleteUserMembership(String id, String userId) throws ApiException
      Delete a Tenant User Membership Deletes a membership between a tenant and an user.
      Parameters:
      id - The id of the tenant. (required)
      userId - The id of the user. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteUserMembership

      public void deleteUserMembership(String id, String userId, Map<String,String> additionalHeaders) throws ApiException
      Delete a Tenant User Membership Deletes a membership between a tenant and an user.
      Parameters:
      id - The id of the tenant. (required)
      userId - The id of the user. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getTenant

      public TenantDto getTenant(String id) throws ApiException
      Get Tenant Retrieves a tenant.
      Parameters:
      id - The id of the tenant to be retrieved. (required)
      Returns:
      TenantDto
      Throws:
      ApiException - if fails to make API call

    • getTenant

      public TenantDto getTenant(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Tenant Retrieves a tenant.
      Parameters:
      id - The id of the tenant to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      TenantDto
      Throws:
      ApiException - if fails to make API call

    • getTenantCount

      public CountResultDto getTenantCount(String id, String name, String nameLike, String userMember, String groupMember, Boolean includingGroupsOfUser) throws ApiException
      Get Tenant Count Query for tenants using a list of parameters and retrieves the count.
      Parameters:
      id - Filter by the id of the tenant. (optional)
      name - Filter by the name of the tenant. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      userMember - Select only tenants where the given user is a member of. (optional)
      groupMember - Select only tenants where the given group is a member of. (optional)
      includingGroupsOfUser - Select only tenants where the user or one of his groups is a member of. Can only be used in combination with the `userMember` parameter. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getTenantCount

      public CountResultDto getTenantCount(String id, String name, String nameLike, String userMember, String groupMember, Boolean includingGroupsOfUser, Map<String,String> additionalHeaders) throws ApiException
      Get Tenant Count Query for tenants using a list of parameters and retrieves the count.
      Parameters:
      id - Filter by the id of the tenant. (optional)
      name - Filter by the name of the tenant. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      userMember - Select only tenants where the given user is a member of. (optional)
      groupMember - Select only tenants where the given group is a member of. (optional)
      includingGroupsOfUser - Select only tenants where the user or one of his groups is a member of. Can only be used in combination with the `userMember` parameter. Value may only be `true`, as `false` is the default behavior. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • queryTenants

      public List<TenantDto> queryTenants(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String id, String name, String nameLike, String userMember, String groupMember, Boolean includingGroupsOfUser) throws ApiException
      Get Tenants Query for a list of tenants using a list of parameters. The size of the result set can be retrieved by using the [Get Tenant Count](https://docs.camunda.org/manual/7.21/reference/rest/tenant/get-query-count/) method.
      Parameters:
      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)
      id - Filter by the id of the tenant. (optional)
      name - Filter by the name of the tenant. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      userMember - Select only tenants where the given user is a member of. (optional)
      groupMember - Select only tenants where the given group is a member of. (optional)
      includingGroupsOfUser - Select only tenants where the user or one of his groups is a member of. Can only be used in combination with the `userMember` parameter. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      List<TenantDto>
      Throws:
      ApiException - if fails to make API call

    • queryTenants

      public List<TenantDto> queryTenants(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String id, String name, String nameLike, String userMember, String groupMember, Boolean includingGroupsOfUser, Map<String,String> additionalHeaders) throws ApiException
      Get Tenants Query for a list of tenants using a list of parameters. The size of the result set can be retrieved by using the [Get Tenant Count](https://docs.camunda.org/manual/7.21/reference/rest/tenant/get-query-count/) method.
      Parameters:
      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)
      id - Filter by the id of the tenant. (optional)
      name - Filter by the name of the tenant. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      userMember - Select only tenants where the given user is a member of. (optional)
      groupMember - Select only tenants where the given group is a member of. (optional)
      includingGroupsOfUser - Select only tenants where the user or one of his groups is a member of. Can only be used in combination with the `userMember` parameter. Value may only be `true`, as `false` is the default behavior. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<TenantDto>
      Throws:
      ApiException - if fails to make API call

    • updateTenant

      public void updateTenant(String id, TenantDto tenantDto) throws ApiException
      Update Tenant Updates a given tenant.
      Parameters:
      id - The id of the tenant. (required)
      tenantDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • updateTenant

      public void updateTenant(String id, TenantDto tenantDto, Map<String,String> additionalHeaders) throws ApiException
      Update Tenant Updates a given tenant.
      Parameters:
      id - The id of the tenant. (required)
      tenantDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call