Component Level Role-Based Access Control (RBAC)
Overview
Each role has a set of access privileges for what end-users can and can’t do in your modules. The way Unqork works, an end-user’s role defines their access to modules. That is unless you override that access. Not only can you overwrite access at the module-level. You can also overwrite access for specific components in modules. A role might need different access to a component than their role or module-based access allows. Setting RBAC for specific components is how you handle access.
In Module Builder Settings, set the Customize RBAC for this module toggle to ON. Then you can override default permissions for any role at the component-level. To access component-level RBAC, click the Permissions tab in any component's configuration window. Here you'll see a list of roles and the option to edit their permissions for that component.
What You’ll Learn
In this
- How to access Module Builder settings.
- How to add RBAC to a module.
- How to add anonymous access to a component.
Accessing Module Builder Settings
In Module Builder Settings, you can choose how your module interacts with APIs (application programming interfaces) and end-users. Here, you’ll adjust your module’s settings for RBAC. With RBAC enabled, you can set component-level permissions. Navigate to Module Builder Settings.
To access Module Builder Settings:
1. | Open your module in the Module Builder. |
2. | Hover over the left menu bar. |
3. | Click Settings. |
Adding RBAC to a Module
Now, return to the Customize RBAC for this Module setting. This setting lets you customize module and component access on a per-role basis. RBAC is useful if you want certain roles to interact with your components and modules.
To add RBAC to your module:
1. | Set the Customize RBAC for this Module toggle to ON. After toggling to ON, more fields activate. These include the Allow Access to Anonymous Users and Module Permissions sections. |
2. | Choose from a role's Permission drop-down to override its default permission. The permission options are: |
Permission |
Description |
---|---|
Inherit |
Inherit means that the role's access in this module is the same as the environmental level. |
No Access |
Your end-user has no access to your component. |
Read-Only |
Your end-user can view but cannot write or engage with your application. |
Write |
Your end-user has full access to write and engage with your application. |
3. | Click Save Settings. |
Adding RBAC to a Component
Now that you enabled RBAC for your module, you can set RBAC for components in that module.
To add RBAC to your component:
1. | Open your module. |
2. | Hover over the component. |
A 5-button toolbar displays above the component on hover-over.
3. | Using the toolbar, click the (Settings) button. |
4. | Click the Permissions tab. |
5. | Choose from a role's Permission drop-down to override its default permission. The permission options are: |
Permission |
Description |
---|---|
Inherit |
Inherit means that the role's access in this component is the same as the environmental level. |
No Access |
Component is hidden from your end-user in the front end. |
Obfuscate |
Your end-user can view this field, but it appears as asterisks (*). The end-user cannot write or engage with the component. |
Read-Only |
Your end-user can view but cannot write or engage with your component. |
Write |
Your end-user has full access to write and engage with your component. |
6. | Click Save. |