🧑‍💼 Guide: User Management

This guide provides a step-by-step walkthrough for managing users within the platform, including creating regular users and API users, configuring permissions, and editing or deleting users.

Step 1: Accessing the User Section

1.1: Initial Navigation

1. Go to the platform’s main menu

2. Locate and click the “Users” option

1.2: Viewing the Users Table

1. A table will be displayed (empty for new clients)

2. Find the “Add User” button on the screen
   📌 This is the starting point for user creation

Step 2: Creating a Regular User (Platform Access)

2.1: Starting the Process

1. Click the “Add User” button

2. A new form screen will appear

3. You will see 4 required fields

2.2: Filling Out the Regular User Form

• Field 1 — User Type: Select “Regular” (grants access to the platform)

• Field 2 — Name: Enter the user’s full name

• Field 3 — Email: Provide a valid email (used for login and notifications)

• Field 4 — Phone: Add the user's phone number

2.3: Completing the Creation

• Click “Confirm” to save the user

• Or click “Cancel” to abort the process

Step 3: Creating an API User

3.1: Initial Configuration

1. Click the “Add User” button

2. In the “User Type” field, change from Regular to API
   📌 API users require fewer fields

3.2: Filling Out the API User Form

• Field 1 — User Type: Confirm it’s set to “API”

• Field 2 — Name: Enter an identifier name for the API user

• Click “Save”

3.3: Retrieving API Credentials

1. Wait for the “Operation successful” popup
   ⚠️ IMPORTANT: Write down the Client Secret immediately
   ✅ Store the credentials securely (they won’t be shown again)
   🔑 The Client Secret is used for API integration
   🆔 The Client ID will be visible in the user table later

Step 4: Managing the Users Table

4.1: Table Overview

Once users are created, you’ll return to the main table view. The columns include:

• User Name

• Identifier: Email (Regular) or long ID (API)

• Phone

• Created By

• Creation Date

• Last Update: Date and responsible user

• Verified: Green check if successful

• Status: Enabled/Disabled

• MFA: Multi-factor authentication status

4.2: Understanding Statuses

• ✅ Verified: Indicates successful user creation

• 🔄 Status: Shows if the user is active on the platform

• 🔐 MFA: Indicates if two-step verification is enabled

Step 5: Configuring Permissions (For Platform Users)

5.1: Accessing Permission Settings

1. Wait for the user to complete their first access

2. Return to the user management page

3. Locate the user in the table

5.2: Editing Permissions

1. Click the “Edit” button on the desired user

2. Locate the “Select a Role” dropdown

3. Choose the appropriate permission level:

• 👁 Read: View-only access

• ✏ Write: Can modify data

• 🔓 Full Access: Unrestricted access

5.3: Saving Permission Changes

• Confirm your selections

• Click “Save”

• ✅ Ensure the changes were applied correctly

Step 6: Additional User Actions

6.1: Editing Existing Users

1. In the users table, click “Edit” for the desired user

2. Modify fields such as name, email, or phone

3. Save the changes

6.2: Deleting Users

1. In the users table, click “Delete” for the desired user

2. Confirm the deletion when prompted
   ⚠️ WARNING: This action cannot be undone