Roles

Iguana X has a role based permission system to restrict user access to various Iguana system and component controls.

By default, every Iguana instance has an admin user with full access to Iguana system and component controls. Any users created by the admin must be granted access permissions through the use of roles to perform any iguana system or component actions.

Roles contain a list of granted permissions and are assigned to users and components as #role Tags. There are two types of roles:

1) User Role - assigned to users to grant Iguana system and component controls.

User Roles are assigned to users to grant Iguana system and component controls.

For example, you may have separate #roles for team members using Iguana based on their needs

#dev who has full controls
#support who may only require access the logs, start/stop components and view scripts.

Screen Shot 2024-03-20 at 5.22.29 PM.png

2) Component Role - assigned to both a user and component(s) to apply permissions to particular components

These can be used when you have particular components that you want to place further restrictions on. For a Component Role to apply, the User (agent) and the component (target) must have matching #roles.

For example, critical components that may be used for operational purposes which do not need to be accessed by every user, a #critical role can be created and assigned to the component and the users who require access. Any user without the matching #critical role assigned, will not have the permissions on that #critical components.

Screen Shot 2024-03-20 at 5.22.47 PM.png

Creating Roles

In Settings > Roles, click Add and enter a #role name

Click Add Role at the top right corner of the Roles page.
In the Add a Role window, enter your #role name and click Add.

Note: Tags are case sensitive and must match exactly when applied to Users and Components.

Screen Shot 2024-03-04 at 12.09.20 PM.png

Choose the Role Type and use the check boxes to grant permissions to system and component controls

Choose the Role Type - User or Component.
Use the select all or check boxes to choose the the Iguana system and component controls you want to grant users and/or components with this role - click Save.
Once a role is created, it can be edited or deleted as required.

Screen Shot 2024-03-20 at 5.39.07 PM.png

Assigning Roles

Assign each user a User Role and optional Component Roles can be assigned to Users in Settings > Users

In Settings > Users, click Edit on the User you wish to add a role. You can add multiple roles to a single user to apply both User Roles and Component Roles.

Screen Shot 2024-03-20 at 5.34.01 PM.png

Component Roles must be assigned to both the required Users and the Components.

Component Roles are assigned to components in the Component Card Tags field.

Open a component card and enter the #role in the Tags field. Once entered, a role related tag will be bold and link you to the Role configuration if clicked.
If you want to add a #role to multiple components, you can use Bulk Editing of Tags in the Bulk Action bar on the Dashboard.

Screen Shot 2024-03-20 at 5.45.07 PM.png

Once unique Users and Roles are configured in your Iguana instance, if you have another User with full admin rights, you can delete the admin user. In the future if this needs to be restored, you can do so on the command line.