Skip to main content

Manage User Accounts

In this section, you can explore topics such as:

Create user account

  • This option allows you to add and manage user accounts within the portal. It provides the following functionalities:
  1. Add New User Accounts: Administrators can create new user profiles by entering relevant details such as username, email, password, and other necessary credentials. You can also assign roles and permissions during the user creation process.

  2. Manage Existing User Accounts: This includes the ability to view and modify user information, such as updating contact details, resetting passwords, or changing assigned roles and privileges. You can also activate, deactivate, or delete user accounts as necessary.

  • To add a new client within the system, follow these navigation steps:

  • Clients: Start by navigating to the Clients section of the platform. This section is typically where all client-related actions are managed, such as viewing existing clients, creating new ones, or managing client details.

  • Create & Manage User Accounts: Within the Clients section, locate the option for Create & Manage User Accounts. This option is where you can perform actions related to user account management, such as adding new client accounts, editing current user information, and assigning roles or permissions.

  • Add Client: Once you are in the Create & Manage User Accounts area, select the Add Client option. This option will prompt you to input relevant details about the new client, such as their name, email, contact information, and any other required credentials. You may also set the client's roles and privileges during this process.

  • Choose either New User or Existing User. Selecting New User allows you to add a client with a newly created user account, while selecting Existing User adds a client under an already existing domain.

  • Choose either the Organization or Individual plan. Selecting Organization will register the client under the Organization plan type, while selecting Individual will register the client under the Individual plan type.

  • The available billing plan types are Postpaid and Prepaid. You can select either one of these options.

  • The available billing contract types are Fixed Payment and Pay-as-you-go, and you can choose either option:

  • Fixed Payment: A set monthly payment, regardless of usage.

  • Pay-as-you-go: Monthly payment based on the actual resources used.

  • Fill in the required fields such as First Name, Last Name, Country & Code, Cell Phone, Primary Email, City, Address, Postal Code, Time Zone, Billing Plan, Billing Contract Type, Currency, Payment Type, Password, and Confirm Password, then click the Add button.

  • The user account has been successfully added.

Manage User Account

  • To Manage the user accounts, follow these steps:
  1. Clients: Begin by navigating to the Clients section of the portal, where you can manage and view all client-related information.

  2. Create & Manage User Accounts: Within the Clients section, click on Create & Manage User Accounts. This area allows you to create new user accounts, manage existing ones, and perform other account-related tasks.

  3. Select Your Account: From the list of user accounts, locate and select the account you want to manage or view in more detail. It will redirect you to the Client Detail screen.

Account Summary

  • In the clients details screen, you can view detailed information about usage costs for both the current month and the previous month. The display includes a breakdown of expenses incurred during these periods, allowing you to analyze your spending patterns. You can typically find specific metrics such as:

  • Current Month Usage Costs: This shows the total costs associated with your services and resources for the ongoing month, reflecting real-time usage.

  • Last Month Usage Costs: This section provides a summary of expenses from the previous month, enabling you to compare costs with the current month and identify any trends or fluctuations.

  • You have the capability to edit and update the credit limit assigned to a user account. This functionality allows you to adjust the maximum amount of credit that a user can utilize within the system, which is particularly important for managing financial risk and ensuring that users do not exceed their allocated budgets.
  • You will find the value of the user’s promotional code prominently displayed. This promotional code is often used to apply discounts or special offers to the user’s account, enhancing their overall experience by providing financial benefits.

  • For further information about the promotional code, there is a clear directive to navigate to Billing > Promocode.

  • The portal provides a clear overview of the user’s average monthly income details. This information is crucial for both users and administrators, as it helps in assessing financial health, budgeting, and making informed decisions regarding services or upgrades.
  • The "Login as User" feature provides administrators with the ability to access a client's portal without needing the client's credentials. This functionality is particularly useful in various scenarios, such as troubleshooting, providing support, or managing user accounts.
  • You can view the client's billing information, including paid, draft, overdue, due, and cancelled invoices, from the client details page.
  • In the 'Other Actions' section, you will find several options including 'Delete Resource,' 'Suspend Account,' and 'Disable User Account.
  • The "Delete Resource" option allows administrators to remove specific resources associated with a user's account. When this action is initiated, the system typically prompts the admin to confirm the deletion to prevent accidental loss of important data or functionality. Once confirmed, the selected resources will be permanently removed from the user's account, effectively freeing up any allocated space or services. This action may be necessary for various reasons, such as managing resource usage, decluttering user accounts, or enforcing policy compliance. It's essential to ensure that any resources deleted are no longer needed by the user, as this action is often irreversible.
  • The "Suspend/Resume User Account" option provides administrators with the ability to temporarily halt or reactivate a user's account.

Suspend User Account: When an account is suspended, the user is unable to log in or access any associated resources or services. This action is often taken in situations such as non-compliance with policies, payment issues, or security concerns. Suspending an account does not delete any user data; instead, it serves as a way to pause the account's activity while retaining all information for potential future reinstatement.

Resume User Account: Conversely, when an account is resumed, the user regains full access to their account and all previously associated resources and services. This action is typically taken after resolving any issues that led to the suspension, such as addressing billing concerns or compliance matters.

  • The "Enable/Disable User Account" feature allows administrators to manage the accessibility of a user’s account based on specific needs or circumstances.

Enable User Account:

When a user account is enabled, the user can log in and access all the resources and services associated with their account. This action is typically taken after the account has been disabled for various reasons, such as inactivity, compliance issues, or security concerns. Enabling the account restores the user’s access rights, allowing them to continue using the platform as intended.

Disable User Account:

Conversely, when a user account is disabled, the user is completely barred from logging in and accessing their account or any associated services. This action does not delete the user’s data; instead, it effectively freezes the account status. Disabling an account may be necessary in scenarios such as:

  • Security Concerns: If there is suspicion of unauthorized access or suspicious activity, disabling the account can help protect sensitive information.
  • Policy Violations: Accounts that do not adhere to organizational policies may be disabled until the issues are resolved.
  • Inactivity: Accounts that have been inactive for a prolonged period can be disabled to streamline user management.

The ability to enable or disable user accounts provides administrators with a flexible tool for managing user access and ensuring compliance with organizational policies while maintaining the integrity of user data for potential future access.

  • The "My Clients" section serves as a centralized interface for administrators to view and manage all users associated with their organization. This feature is essential for effectively overseeing client relationships, monitoring user activity, and ensuring that all clients receive the necessary support and resources.

Profile

  • This section enables administrators to access and modify the personal and account-related information of clients. Keeping client profiles up-to-date is essential for effective communication, support, and service delivery.

  • Also, allows administrators to reset or change the password for the client’s account on the portal, enhancing security and user access management.

KYC Verification

  • The KYC (Know Your Customer) verification procedure for a client can be reviewed and approved in this section. To verify customer identities and stop fraud, money laundering, and other illegal actions, KYC is a crucial compliance requirement in many businesses, but especially in banking.
  • For more details or to manage KYC configurations, administrators should navigate to the path: Config > My Organization > KYC Configuration.

Products & Services

  • This section is a key feature within a billing or account management system that provides a detailed breakdown of the services a user has subscribed to or utilized.

1. List of Services

  • What it Displays: This section will display all the products and services that the user has purchased or subscribed to. Each service will be listed individually, allowing the user to see exactly what they are being billed for.
  • Examples: Services might include things like cloud storage, virtual machines, managed databases, network services, etc., depending on the provider.

2. Usage Hours

  • What it Means: For services billed based on time (e.g., computing instances, virtual machines, or any metered services), the Usage Hours column shows the total hours of usage during the billing cycle.
  • Usage-Based Billing: This is particularly important for services that are billed based on consumption rather than a flat fee. For instance, if a virtual machine was running for 120 hours in a month, this will be recorded here.

3. Amount Charged

  • Breakdown of Costs: The **Amount ** column displays the cost associated with each listed service.
  • Per Service Billing: This could be based on different billing models—either a flat rate (for example, a subscription fee for a software service) or based on usage (for example, a fee per gigabyte of data transferred or per hour of cloud compute service used).
  • Transparency: This gives the user transparency, allowing them to understand exactly how much each service is costing them, so they can monitor their spending and make adjustments if necessary.

Invoices

  • This section allows users to sort and view invoices based on specific criteria. Here's a detailed elaboration of this functionality:
    • Paid: Invoices that have been settled and payment has been received.
    • Due: Invoices that are still pending payment and are within the payment term.
    • Overdue: Invoices that have not been paid by the due date and require immediate attention.
    • Draft: Invoices that have been created but not yet finalized or sent to clients.
    • Cancelled: Invoices that have been voided and are no longer valid.
  • Purpose: Filtering by status allows users to quickly assess their accounts receivable and identify which invoices need follow-up action or payment. It simplifies the task of tracking outstanding payments or managing accounts.

Payment

This section allows administrators or account managers to view a detailed list of all payments made by a specific client. The payment list usually includes:

  • Transaction Dates: The dates on which payments were made.
  • Payment Amounts: The total amount paid in each transaction.
  • Payment Methods: The method used for each payment (e.g., credit card, PayPal, bank transfer).
  • Invoices or Services Paid: The specific invoices or services that were covered by each payment.
  • Status: The status of the payment (e.g., completed, pending, failed).

It also allows an administrator to issue refunds to clients for specific payments they have made. The refund process generally involves:

  • Selecting the Payment: The administrator selects a particular transaction from the payment list that is eligible for a refund.
  • Issuing the Refund: Once selected, the system processes the refund, either partially or in full, depending on the policy.
  • Refund Method: The refund is usually sent back to the original payment method used by the client.

Quota Limit

  • This section allows an administrator or account manager to modify the amount of resources (quota) that a client is allowed to use. A "quota" typically refers to the allocation of certain resources or services within a system. These resources can be things like storage space, CPU usage, memory, bandwidth, the number of virtual machines, or any other service that is limited by quantity or capacity.

Purpose:

  • Resource Management: The purpose of this feature is to control the amount of system resources that a client is permitted to use. By editing or updating a client's quota limit, the administrator can increase or decrease the allowable usage based on the client’s subscription plan or usage needs.

  • Fair Use: This ensures that resources are distributed fairly among users and that no single client consumes too much, potentially affecting others.

  • Flexibility: If a client needs more resources (e.g., storage space or CPU usage), the admin can easily adjust the quota based on their request or business requirements.

  • Also, setting the quota limit to -1 typically represents "unlimited" usage, meaning the client is not restricted by any fixed quota. This means the client can consume as much of the allocated resource as they need without hitting any predefined limit.

Purpose:

  • No Restriction: The -1 value gives the client unrestricted access to the specific resource, removing any cap on their usage.
  • Premium Plans: This setting is often used for clients who are on premium or enterprise-level plans where they are allowed unlimited usage of certain resources as part of their agreement.
  • Convenience: It removes the need for the admin to keep adjusting the quota manually as the client’s usage grows.

Usage History

  • In this section provides a visual representation of the client's usage of resources or services over time in the form of a graph. This graph shows historical data related to the resources consumed by the client, such as storage, bandwidth, CPU usage, or any other resource allocated to the client.

Purpose:

  • Monitor Resource Usage: The primary purpose of the usage history graph is to allow both the administrator and the client to monitor how much of the allocated resources have been consumed over a specific time period (daily, weekly, monthly, or yearly).
  • Track Trends: It provides insights into usage trends, making it easier to identify periods of high or low resource consumption.
  • Forecast Needs: By looking at the past usage data, clients and admins can predict future resource needs, helping with capacity planning and optimization.
  • Billing & Cost Control: This data can also help explain the client's billing by showing how much of the resources they have consumed, especially in pay-as-you-go or consumption-based plans.

Additional Service

In this section portal displays a list of additional services that a client has subscribed to or has available. These additional services are typically add-ons or extra features that go beyond the standard package the client has initially subscribed to.

Purpose:

  • Display of Extra Services: The list gives a detailed overview of all the extra services a client is either using or has access to, in addition to the primary services they initially purchased.
  • Service Management: It allows the client to manage these services, such as adding or removing them based on their needs.

For more comprehensive information about these services (such as how to activate new ones, current usage, or pricing details) can be found by navigating to the Products > Additional Service section within the portal. This area likely provides more control over managing these add-ons, such as viewing details about each service or making changes to the subscription.

API Keys

  • In this section it will process of generating or updating API keys for a client, as well as assigning roles to control the access levels of the generated API keys. API keys are essential for allowing clients or external systems to interact securely with the platform through its API (Application Programming Interface).

  • API keys act as credentials to authenticate clients when they access specific services or resources via the API. By generating an API key, you provide the client with a unique identifier that will allow them to access your system’s services.

  • After assigning the role, clicking the Generate Key button will create the new API key for the client. The client can then use this key in their API requests to interact with the system according to the role's permissions.

  • After generating the API key, the changes must be confirmed by clicking the Update button. This saves the changes and activates the new or modified API key in the system.

  • Clicking the Swagger API link will redirect you to the Swagger API portal.
  • This section allows you to view the Swagger API portal, where you can explore and interact with the API documentation, test various API endpoints, and see detailed information about the available API functionalities.

  • You will be able to access the Swagger API portal screen. This interface provides interactive documentation for the APIs, allowing users to view available endpoints, see how the API requests and responses are structured, and test the APIs in real time. It is a useful tool for developers to understand how to integrate with and utilize the available APIs effectively.

  • To test the API, enter the client's API key and secret key into the designated fields and click the 'Try it out!' button. This action will execute the API request and display the response in real time, showing the outcome of the REST API operation specific to the chosen zone. The response will include important details like the success or failure of the operation, any returned data, and status codes, helping you validate and troubleshoot API requests.

Multi-Currency

  • In this section, you have the ability to update the client's currency settings. To do this, first, select the appropriate currency that reflects the client's actual transaction needs from the available options. Once you have made your selection, click the 'Update' button to save the changes.

  • For additional information and a more comprehensive understanding of managing multiple currencies for clients, you can navigate to the 'Billing' section and explore the 'Multi-Currency feature.' This feature provides insights into how to handle various currencies effectively, allowing for more accurate billing and financial reporting in accordance with the client's preferences.

Import/Export users

  • From the user list page, you have the option to download a comprehensive report containing all relevant information about your clients. By clicking the XLSX button, the system will generate a file in the Excel format (.xlsx) that can be opened using spreadsheet software. This report typically includes essential details such as client names, contact information, account status, and any other pertinent data, allowing for easy analysis and record-keeping.
  • The import feature allows you to add multiple new users to the system efficiently. By clicking the Import button, you initiate the process of importing user data from a pre-prepared file. This streamlines the onboarding process by enabling batch uploads instead of entering user information individually.

  • After clicking the Import button, you will be prompted to select the file containing the new user data from your computer. This file should adhere to the specified format and include all necessary fields for the users being added. Once you have selected the appropriate file, click the Upload button to begin the import process. The system will validate the file to ensure it meets the required criteria.

  • It is important to note that the system has specific file format requirements for the import process. Only files in CSV (Comma-Separated Values), XLS (Excel 97-2003 Workbook), or XLSX (Excel Workbook) formats are supported. This ensures compatibility and allows for smooth data importation. If the file you attempt to upload is in a different format, you will receive an error message, prompting you to convert it to one of the accepted formats.

  • Once the import process is complete, you will receive a confirmation message indicating that the new users have been successfully added to the system. This assures you that the data has been processed correctly and that the new users are now available in the system for any necessary actions, such as granting access or assigning roles. This functionality enhances the efficiency of user management and supports the growth of your user base without significant manual effort.

User Filters

This feature allows you to apply specific filters to the client list displayed within the application. By using these filters, you can refine the list of clients based on particular criteria. The available filters include:

  • Billing Contract Type: This filter lets you select clients based on their billing arrangement, such as fixed payment plans or pay-as-you-go plans. This can help you quickly identify clients who fall under certain contractual obligations.
  • Billing Type: This option allows you to filter clients based on their billing method, which could include pre-paid or post-paid options. This distinction can be crucial for understanding the payment preferences and behaviors of different clients.
  • Client Status: With this filter, you can categorize clients by their current status, such as active, inactive, or suspended. This helps in monitoring the engagement and activity levels of clients.

When you select the “All” filter option, the portal displays a comprehensive list of all clients in the database, regardless of their billing contract type, billing type, or status. This is useful for administrators who want to have a complete overview of every client and their respective details. By presenting all clients, this option facilitates easier management and tracking of client accounts without restrictions.

Selecting the "Billing Admin" filter limits the displayed client list to those clients who have specific billing relationships or are actively involved in billing processes. This might include clients currently under billing contracts or those with pending invoices. The purpose of this filter is to provide billing administrators with a focused view, allowing them to manage billing-related tasks more effectively without the distraction of non-billing clients. By narrowing down the client list in this way, billing admins can prioritize their efforts on clients that require immediate attention or action regarding billing issues.