Package org.openapitools.client.api

Class TenantApi

  • public class TenantApi
extends Object

    • Constructor Detail

      • TenantApi

        public TenantApi()

      • TenantApi

        public TenantApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • availableTenantGroupMembersOperationsCall

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

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • availableTenantGroupMembersOperationsWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableTenantGroupMembersOperationsWithHttpInfo​(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:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableTenantGroupMembersOperationsAsync

        public okhttp3.Call availableTenantGroupMembersOperationsAsync​(String id,
                                                               ApiCallback<ResourceOptionsDto> _callback)
                                                        throws ApiException
        Tenant Group Membership Resource Options (asynchronously) 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)
        _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

      • availableTenantInstanceOperationsCall

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

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • availableTenantInstanceOperationsWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableTenantInstanceOperationsWithHttpInfo​(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:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableTenantInstanceOperationsAsync

        public okhttp3.Call availableTenantInstanceOperationsAsync​(String id,
                                                           ApiCallback<ResourceOptionsDto> _callback)
                                                    throws ApiException
        Tenant Resource Options (asynchronously) 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)
        _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

      • availableTenantResourceOperationsCall

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

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • availableTenantResourceOperationsWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableTenantResourceOperationsWithHttpInfo()
                                                                              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:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableTenantResourceOperationsAsync

        public okhttp3.Call availableTenantResourceOperationsAsync​(ApiCallback<ResourceOptionsDto> _callback)
                                                    throws ApiException
        Tenant Resource Options (asynchronously) 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:
        _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

      • availableTenantUserMembersOperationsCall

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

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • availableTenantUserMembersOperationsWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableTenantUserMembersOperationsWithHttpInfo​(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:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableTenantUserMembersOperationsAsync

        public okhttp3.Call availableTenantUserMembersOperationsAsync​(String id,
                                                              ApiCallback<ResourceOptionsDto> _callback)
                                                       throws ApiException
        Tenant User Membership Resource Options (asynchronously) 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)
        _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

      • createGroupMembershipCall

        public okhttp3.Call createGroupMembershipCall​(String id,
                                              String groupId,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for createGroupMembership
        Parameters:
        id - The id of the tenant. (required)
        groupId - The id of the group. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • createGroupMembershipWithHttpInfo

        public ApiResponse<Void> createGroupMembershipWithHttpInfo​(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)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createGroupMembershipAsync

        public okhttp3.Call createGroupMembershipAsync​(String id,
                                               String groupId,
                                               ApiCallback<Void> _callback)
                                        throws ApiException
        Create Tenant Group Membership (asynchronously) Creates a membership between a tenant and a group.
        Parameters:
        id - The id of the tenant. (required)
        groupId - The id of the group. (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

      • createTenantCall

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

      • createTenant

        public void createTenant​(TenantDto tenantDto)
                  throws ApiException
        Create Tenant Create a new tenant.
        Parameters:
        tenantDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createTenantWithHttpInfo

        public ApiResponse<Void> createTenantWithHttpInfo​(TenantDto tenantDto)
                                           throws ApiException
        Create Tenant Create a new tenant.
        Parameters:
        tenantDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createTenantAsync

        public okhttp3.Call createTenantAsync​(TenantDto tenantDto,
                                      ApiCallback<Void> _callback)
                               throws ApiException
        Create Tenant (asynchronously) Create a new tenant.
        Parameters:
        tenantDto - (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

      • createUserMembershipCall

        public okhttp3.Call createUserMembershipCall​(String id,
                                             String userId,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for createUserMembership
        Parameters:
        id - The id of the tenant. (required)
        userId - The id of the user. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • createUserMembershipWithHttpInfo

        public ApiResponse<Void> createUserMembershipWithHttpInfo​(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)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createUserMembershipAsync

        public okhttp3.Call createUserMembershipAsync​(String id,
                                              String userId,
                                              ApiCallback<Void> _callback)
                                       throws ApiException
        Create Tenant User Membership (asynchronously) Creates a membership between a tenant and an user.
        Parameters:
        id - The id of the tenant. (required)
        userId - The id of the user. (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

      • deleteGroupMembershipCall

        public okhttp3.Call deleteGroupMembershipCall​(String id,
                                              String groupId,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for deleteGroupMembership
        Parameters:
        id - The id of the tenant. (required)
        groupId - The id of the group. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteGroupMembershipWithHttpInfo

        public ApiResponse<Void> deleteGroupMembershipWithHttpInfo​(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)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteGroupMembershipAsync

        public okhttp3.Call deleteGroupMembershipAsync​(String id,
                                               String groupId,
                                               ApiCallback<Void> _callback)
                                        throws ApiException
        Create Tenant Group Membership (asynchronously) Creates a membership between a tenant and a group.
        Parameters:
        id - The id of the tenant. (required)
        groupId - The id of the group. (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

      • deleteTenantCall

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

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteTenantWithHttpInfo

        public ApiResponse<Void> deleteTenantWithHttpInfo​(String id)
                                           throws ApiException
        Delete Tenant Deletes a tenant by id.
        Parameters:
        id - The id of the tenant 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

      • deleteTenantAsync

        public okhttp3.Call deleteTenantAsync​(String id,
                                      ApiCallback<Void> _callback)
                               throws ApiException
        Delete Tenant (asynchronously) Deletes a tenant by id.
        Parameters:
        id - The id of the tenant 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

      • deleteUserMembershipCall

        public okhttp3.Call deleteUserMembershipCall​(String id,
                                             String userId,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for deleteUserMembership
        Parameters:
        id - The id of the tenant. (required)
        userId - The id of the user. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteUserMembershipWithHttpInfo

        public ApiResponse<Void> deleteUserMembershipWithHttpInfo​(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)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteUserMembershipAsync

        public okhttp3.Call deleteUserMembershipAsync​(String id,
                                              String userId,
                                              ApiCallback<Void> _callback)
                                       throws ApiException
        Delete a Tenant User Membership (asynchronously) Deletes a membership between a tenant and an user.
        Parameters:
        id - The id of the tenant. (required)
        userId - The id of the user. (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

      • getTenantCall

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

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getTenantWithHttpInfo

        public ApiResponse<TenantDto> getTenantWithHttpInfo​(String id)
                                             throws ApiException
        Get Tenant Retrieves a tenant.
        Parameters:
        id - The id of the tenant to be retrieved. (required)
        Returns:
        ApiResponse<TenantDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTenantAsync

        public okhttp3.Call getTenantAsync​(String id,
                                   ApiCallback<TenantDto> _callback)
                            throws ApiException
        Get Tenant (asynchronously) Retrieves a tenant.
        Parameters:
        id - The id of the tenant 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

      • getTenantCountCall

        public okhttp3.Call getTenantCountCall​(String id,
                                       String name,
                                       String nameLike,
                                       String userMember,
                                       String groupMember,
                                       Boolean includingGroupsOfUser,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getTenantCount
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getTenantCountWithHttpInfo

        public ApiResponse<CountResultDto> getTenantCountWithHttpInfo​(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:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getTenantCountAsync

        public okhttp3.Call getTenantCountAsync​(String id,
                                        String name,
                                        String nameLike,
                                        String userMember,
                                        String groupMember,
                                        Boolean includingGroupsOfUser,
                                        ApiCallback<CountResultDto> _callback)
                                 throws ApiException
        Get Tenant Count (asynchronously) 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)
        _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

      • queryTenantsCall

        public okhttp3.Call queryTenantsCall​(String sortBy,
                                     String sortOrder,
                                     Integer firstResult,
                                     Integer maxResults,
                                     String id,
                                     String name,
                                     String nameLike,
                                     String userMember,
                                     String groupMember,
                                     Boolean includingGroupsOfUser,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for queryTenants
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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 fail to call the API, e.g. server error or cannot deserialize the response body

      • queryTenantsWithHttpInfo

        public ApiResponse<List<TenantDto>> queryTenantsWithHttpInfo​(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.18/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:
        ApiResponse<List<TenantDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryTenantsAsync

        public okhttp3.Call queryTenantsAsync​(String sortBy,
                                      String sortOrder,
                                      Integer firstResult,
                                      Integer maxResults,
                                      String id,
                                      String name,
                                      String nameLike,
                                      String userMember,
                                      String groupMember,
                                      Boolean includingGroupsOfUser,
                                      ApiCallback<List<TenantDto>> _callback)
                               throws ApiException
        Get Tenants (asynchronously) 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.18/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)
        _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

      • updateTenantCall

        public okhttp3.Call updateTenantCall​(String id,
                                     TenantDto tenantDto,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for updateTenant
        Parameters:
        id - The id of the tenant. (required)
        tenantDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • updateTenantWithHttpInfo

        public ApiResponse<Void> updateTenantWithHttpInfo​(String id,
                                                  TenantDto tenantDto)
                                           throws ApiException
        Update Tenant Updates a given tenant.
        Parameters:
        id - The id of the tenant. (required)
        tenantDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateTenantAsync

        public okhttp3.Call updateTenantAsync​(String id,
                                      TenantDto tenantDto,
                                      ApiCallback<Void> _callback)
                               throws ApiException
        Update Tenant (asynchronously) Updates a given tenant.
        Parameters:
        id - The id of the tenant. (required)
        tenantDto - (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