Skip to main content

User Role Management Documentation

This document provides a user-friendly guide to managing user roles in the Edit User page. The second area of the page is dedicated to assigning roles, creating modules, and managing permissions for users. Below are detailed instructions and rules for each feature.

Overview of User Role Management​

The user role management section allows administrators to:

  1. Assign roles to users.
  2. Create new modules for grouping roles.
  3. Add new roles to existing modules.
  4. Delete roles and modules.

How to Assign Roles to a User​

  1. Select a Module:

    • Navigate through the tabs at the top of the user role management box.
    • Each tab represents a module (e.g., "IAM", "Payment Manager").
    • Click on the module tab to view its roles.

  2. Assign Roles:

    • Single Role Modules:
      • Select one role from the available options using radio buttons.
    • Multiple Role Modules:
      • Select multiple roles using checkboxes.

  3. Save Changes:

    • Click the Update button at the bottom of the box to save the assigned roles.

How to Create New Modules​

  1. Open the "New Module" Tab:

    • Click the "+" tab at the far right of the module tabs.

  2. Fill Out the Form:

    • Group Title:
      • Enter a unique and descriptive name for the module.
      • Ensure the title does not contain special characters or reserved names (e.g., "Integration Manager").
    • Role Selection Type:
      • Choose between:
        • Single Value: Users can select only one role.
        • Multiple Values: Users can select multiple roles.

  3. Create the Module:

    • Click the Create button to add the new module.

How to Create New Roles for Modules​

  1. Enable Role Creation:

    • Navigate to the desired module tab.
    • Click the New Role button to enable the role creation input.

  2. Add Roles:

    • Type the role name in the input field and press Enter.
    • Repeat for additional roles.

  3. Save Roles:

    • Click the Save button to add the roles to the module.

Rules for Adding Roles​

  1. Role names must be unique within the module.
  2. Role names cannot contain special characters.
  3. Reserved names (e.g., "No Access") cannot be used.

Rules for Adding Modules​

  1. Module titles must be unique.
  2. Titles cannot contain special characters.
  3. Reserved names (e.g., "IAM", "Payment Manager") cannot be used.

Rules for Excluding Roles​

  1. Roles can only be deleted if they are created by user.
  2. Click the delete icon next to the role name to remove it.

Rules for Excluding Modules​

  1. Modules can only be deleted if they are created by user.
  2. Modules cannot be deleted if they contain roles.
  3. Click the Delete button in the module tab to remove it.

Saving Changes​

  1. After assigning roles or creating new roles/modules, click the Update button to save changes.
  2. Ensure all inputs are valid (e.g., no duplicate names, no special characters).

Best Practices​

  1. Use descriptive names for modules and roles to ensure clarity.
  2. Regularly review roles and modules to ensure they align with organizational needs.
  3. Avoid creating unnecessary modules or roles to keep the system manageable.

This documentation provides a comprehensive guide to managing user roles effectively. Follow the steps and rules outlined above to ensure smooth role management.