User roles

How to use the Roles feature of Advanced Permissions to give different user types in your portal different experiences.

Roles is part of our Advanced Permissions feature which is available in Pro portals.

Role Field

In the same way that your user table is entirely managed and contained within your data source, the role for your users is defined in a field in your data source. You may need to create a new field for this.

The field must be of type:

  • Airtable: Single Select Dropdown

Create the field and run a schema update from your data source and enable the field so Stacker is aware of the field before proceeding.

Enabling Roles

Now you have created a Role dropdown field in your base (see above) and updated your schema, you are ready to enable roles.

You can enable roles by visiting the User Settings page from Setup Home.

In the Roles section, expand and enable roles, and select your role field from the dropdown. If you role field is not there then ensure you have run a schema update and then try again.

Adding Roles

Once roles is enabled you can manage your roles on the new Roles page, you will see this on Setup Home. Click into Roles.

You will see that there is one role that has been created for you called Users.

Creating a Role

Use the Add a new role button to create a new role.

Give the role a name and choose the value required in the role field. Users that have this value in their role field will get this role.

Controlling Pages

Each role can have pages associated with it, which means the users in that role can access those pages. Click on the role and then select from the pages available. Those checked will be accessible to users with this role.

You can also control this same setting directly from a list page when in design mode. There is an option for Roles in the sidebar which allows you to select which roles will be able to access the page you are editing.

Navigation note: for an item to show in a users navigation bar it must be enabled in the navigation bar and have access granted to it in the users role.

Controlling Data Access

Each role can have multiple permission rules associated with it, which grant access to data (fields and records) for the users in that role.

You can create a new role directly from the Role page. You need to give it a name (it will be really useful for you later!) and pick which table you are giving access to.

Then you can configure which fields and records should be granted via the rule.

You can also edit any rules from the object permission page and change the roles to which the rule applies.

The Default Role

One of your roles has to be assigned as the default role. The default role is the role that will be assigned to any users that don't match one of the other roles. You can change the default role from any of the role pages. Simply click on the role and select the Make Default checkbox and save.