Roles

Owned by Aryn Wiebe
Last updated: Sept 24, 2024 by Emily Debowski
3 min read

IguanaX 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:

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

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

  • 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.

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

 

  • 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.

Assigning Roles

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.

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.