How to Update to the Roles and Permissions Management System

This document describes how to migrate existing users and Projects to the Managing Roles and Permissions in Glob.AI OS. This one-time process transfers data from existing users and Projects to the role and permission structures.

Prerequisites

Before you start the manual migration process, make sure the latest version of the "Security Configuration" module is installed. This module typically installs or updates automatically during the initial deployment of the environment, at the first access to the Console login.

To verify the module version:

1. Navigate to SuperAdmin Options > System > System Modules.
2. Confirm that the "Security Configuration" module does not show any available updates.

Migrating Manually

If the migration process does not run automatically, you can migrate manually by following these steps:

1. Navigate to SuperAdmin Options > System > System Modules. 
2. Find the "System" module and click Install/Update.
3. Wait for the module to complete the migration process in the background. The module indicates that it has been updated, but you need to check System > Operation Logs for a summary of the migration to confirm it was successful.

Reviewing the Migration Log

The migration log records the following events:

• Start of process: A log entry appears when the migration begins. The "Data" column shows a message similar to "The migration process is about to start...".
• End of process: A log entry appears when the migration finishes. Check that the beginning of the "Data" description confirms a successful execution, for example "OVERALL EXECUTION: SUCCESS = true".
• Step details: You can open a log entry to see every step executed during the migration, such as "Populating OrganizationRole table...".

If the migration fails, the log level shows "ERROR", and the log details indicate where the process failed. When a failure occurs, the system does not commit any changes to the database and continues to function normally without the migrated schema. Review the log to determine the cause of the failure.

If the migration completes successfully, you do not need to take any further action.

Using the Previous Role-Permission Structures

If you need to revert to the previous role-permission structures after a successful migration, configure the following system parameter:

1. Navigate to SuperAdmin Options > System > Parameters.
2. Configure the parameter with these values:
   • Name: USE_OLD_ROLES_SCHEMA
   • Description: Enables the active use of the previous role-permission structures.
   • Type: String
   • Value S: 1

Migrated Projects

When you migrate a Glob.AI OS environment to the Roles and Permissions Management System, the behavior of all existing Projects stays the same. This behavior is not optional for new Projects.

Activating the Scheme in an Existing Project

To activate the role and permission scheme in a previously defined Project, follow these steps:

1. Make sure you have the "Organization Member" role. 
2. Navigate to Organization Options > Project. 
3. Check the Project list for a red exclamation mark (!) next to a Project name. This symbol indicates that the Project has not been migrated to the role and permission scheme.
4. Click UPDATE next to the project.
5. Select the checkbox labeled Check user permissions by API?.

Keep the following in mind:

• Existing Projects do not have a "Project Administrator" role. An "Organization Member" must assign this role to Backend users who need to manage Project members and roles.
• Once you check and confirm this option, you cannot reverse it for that Project.
• Once this Project activates the scheme, its GET/organization/assistants and GET /profiles endpoints require the include-all:true header to return the complete list. Projects that have not activated the scheme always return the complete list without this header.