Migrate to the new role system

Please be sure of your agent type and version and pick the right documentation accordingly.

Node.js

This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.

forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by @forestadmin/agent v1.

Please check your agent type and version and read on or switch to the right documentation.

Ruby on Rails

This is still the latest Ruby on Rails documentation of the forest_liana agent, you’re at the right place, please read on.

Python

This is the documentation of the django-forestadmin Django agent that will soon reach end-of-support.

If you’re using a Django agent, notice that django-forestadmin v1 is replaced by forestadmin-agent-django v1.

If you’re using a Flask agent, go to the forestadmin-agent-flask v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

PHP

This is the documentation of the forestadmin/laravel-forestadmin Laravel agent that will soon reach end-of-support.

If you’re using a Laravel agent, notice that forestadmin/laravel-forestadmin v1 is replaced by forestadmin/laravel-forestadmin v3.

If you’re using a Symfony agent, go to the forestadmin/symfony-forestadmin v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

Migrate to the new role system

The new Role permissions system requires that you use version 6.6+ of your agent (version 5.4+ for Rails) on all your environments. Moreover, if your project was created before February 2021, please contact Forest Admin support to ask for it to be "ready to migrate".

You can read more about Roles in our User Guide.

The new role system allows you to control all the permissions of your roles from a single details page, which will look like this:‌

To start migrating, you will need to ask someone from the Forest Admin customer success team to switch your project to a "Ready to migrate" status.‌

Once this is done, go to the Roles tab of your project settings:‌

Click on Learn more. Then, after you've read the instructions, Start migration process:‌

This is where it gets interesting:‌

All your users will be presented in groups (1) that have the exact same permissions (smart action permissions + collection permissions):‌

If you had created roles and assigned them to smart actions before the migration, they will appear there (2). Additionally, if you had assigned them to users, they will be automatically assigned to those users.‌

If you wish to create more roles, you can do so by clicking Create a new role (3).‌

Then assign the available roles to the users of this group (4).

At the end of the migration, the permissions presented on the left will be assigned to all the roles displayed on the right (under "Roles").

You cannot delete roles at this stage, but you can always rearrange roles after the migration.‌

Lastly, review all assigned roles on the last page and validate to finalize the migration process: