Interface TenantService

    • Method Detail

      • list

        List<? extends Tenant> list()
        Lists tenants to which the specified token has access.
        Returns:
        List of Tenants
      • get

        Tenant get​(String tenantId)
        Gets detailed information about a specified tenant by ID
        Parameters:
        tenantId - the tenant id
        Returns:
        the tenant
      • getByName

        Tenant getByName​(String tenantName)
        Gets detailed information about a specified tenant by name
        Parameters:
        tenantName - the tenant name
        Returns:
        the tenant
      • create

        Tenant create​(Tenant tenant)
        Creates a new Tenant
        Parameters:
        tenant - the tenant to create
        Returns:
        the newly created tenant and it's assigned ID
      • delete

        ActionResponse delete​(String tenantId)
        Deletes the specified tenant by ID
        Parameters:
        tenantId - the tenant id
        Returns:
        the action response
      • update

        Tenant update​(Tenant tenant)
        Updates the tenant (ID must be set within the inbound tenant)
        Parameters:
        tenant - the tenant
        Returns:
        the tenant
      • listUsers

        List<? extends TenantUser> listUsers​(String tenantId)
        Returns a list of users associated by the tenantId
        Parameters:
        tenantId - the tenant id to query users for
        Returns:
        List of TenantUser