Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

By default, the every Iguana instance has an admin user has 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.

In Settings > Roles, the admin user can create custom role #tags with lists of granted permissions.

  • Iguana system permissions will be applied to the User with the assigned role #tag.

  • By default, components have unrestricted permissions - ie. any user can do anything to the component. To apply a matching role #tag to a component, it must be added to the Component Card Tags.

Create a Role

...

. There are two types of roles:

Expand
title1) 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.pngImage Added
Expand
title2) 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.pngImage Added

Creating Roles

Expand
titleIn 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 #tag #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
Expand
titleChoose Iguana and Component controls to grant Users and Components with this Role
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.

types_of_permissions.pngImage Removed

...

Screen Shot 2024-03-20 at 5.39.07 PM.pngImage Added

Assigning Roles

Expand
titleIn Assign each user a User Role and optional Component Roles can be assigned to Users in Settings > Users , add the desired #Role to your User

In Settings > Users, click Edit on the User you wish to add a role. You can add multiple roles to a single user , each role is additive and will provide the user the assigned access permissions.

Screen Shot 2024-03-04 at 1.06.47 PM.pngImage Removed

...

to apply both User Roles and Component Roles.

Screen Shot 2024-03-20 at 5.34.01 PM.pngImage Added
Expand
titleComponents without tags that match a Role have no permission restrictions applied

In the Component Card Tags, you will see an alert stating that there are no matching role tags (no permissions applied), meaning that the User will have full component permissions available.

Screen Shot 2024-03-04 at 1.20.26 PM.pngImage Removed
Expand
titleTo assign a role #tag, it must be added to 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 #tag
  • #role in the Tags field. Once entered, a role related tag will be bold and link you to the Role configuration if clicked.

  • If

a role #tag is assigned to select components, the permissionswill only be applied to the tagged components. If
  • you want to add a

role #tag .Screen Shot 2024-03-04 at 1.23.38 PM.pngImage Removed

If a User applies a #Role tag which does not have Tag editing permission to a component, a warning will appear to confirm the change before applying the new permissions.

Screen Shot 2024-03-04 at 1.29.16 PM.pngImage Removed
Expand
titleAll role #tags assigned to users must be applied to components which need restrictions

When a single role #tag is added to a component, its permissions are applied to all users.

When multiple role #tags are added to a component, only the user’s matching role #tag permissions are applied to user. Therefore best practice is to add all role #tags to a component that requires permissions to be applied so that the appropriate permissions will map to the matching user role
  • on the Dashboard.

Screen Shot 2024-03-20 at 5.45.07 PM.pngImage Added

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.