Role details
In the app: Settings → Roles → click a role
Needs the 'View Team' permission.
The page of one role: its name, its description and every permission it holds. Anyone who can see the team can open a role to read what it allows. Changing a role needs the 'Manage Roles' permission, and how much can be changed depends on the role's type.
What you can change
The trail at the top reads "Edit Role" when you can change something on the page and "Role Details" when you can only read it. A box under the title explains why fields are locked:
- System role (Owner): "This is a system role and cannot be edited." Nothing can be changed, by anyone, and there are no save buttons. To get a variation, an Owner can copy it as a custom role.
- Predefined role: "Permissions are locked for predefined roles." With 'Manage Roles' you can change the name and the description. Nobody can change the permissions, an Owner included. To get different permissions, copy it as a custom role and change the copy.
- Custom role: with 'Manage Roles' you can change the name, the description and the permissions.
- Without 'Manage Roles': every field is locked and the save and duplicate buttons are not shown. On a custom role the box reads "You are viewing this role, not editing it."; on a system or predefined role it keeps its first line and adds that changing roles needs the Manage Roles permission.
If the role cannot be loaded, the page shows "Couldn't load this role." with "Try again". If the role no longer exists, it shows "Role not found" with a link back to the list.
Name and description
Needs the 'Manage Roles' permission.
"Name" is what the role is called everywhere: in the role list, on Settings → Team and when you invite someone. It is required, can be up to 100 characters, and must be different from every other role in the organization.
"Description" is optional. It is shown under the name in the role list. Use it to say what the role is for. A description can be changed but not emptied: saving an empty description keeps the previous text, although the page shows "Role saved successfully".
Permissions
The permissions are grouped in categories. Each category shows how many of its permissions the role holds, for example "(3/15)", and the line above the list shows the total, for example "12 of 122 permissions selected". Click a category to open it and see each permission with a short explanation.
On a custom role you can change, tick or untick single permissions, or use "Select All" or "Deselect All" on a category.
The yellow warning. Some permissions do nothing on their own: a permission to change something needs the matching permission to view it, where Squid has one. When a role holds one without the other, a warning lists each such permission and what it also needs, with the text "Without it, the screen it applies to stays closed to this role." "Add the missing permission" (or "Add the missing permissions") ticks what is missing; you still have to save. The warning does not block saving. It is also shown, without the button, to people who cannot change the role's permissions.
What you may add. You can only add permissions that you hold yourself. If you try to add one you do not hold, saving is refused with "You cannot put permissions into a role that you do not have yourself." and the permission's internal key. Removing permissions, or keeping ones the role already had, is always allowed. Owners can add any permission.
When it takes effect. A change applies to everyone who holds the role as soon as you save. Someone who is working in Squid at that moment may have to reload the page before menus and buttons follow the new permissions.
Duplicate as Custom Role
Needs the 'Manage Roles' permission.
"Duplicate as Custom Role" at the top right opens the "Duplicate as custom role" dialog. Give the copy a name in "Name for the copy" and click "Create copy". The copy is a new custom role with this role's description and every permission it has; nobody is assigned to it yet.
The copy is made from the role as it was last saved. Changes you made on this page and did not save are not in the copy. After copying, Squid opens the copy; if you have unsaved changes it asks first, and if you stay, the copy is waiting in the role list.
You can only copy a role whose permissions you all hold yourself. Owners can copy any role.
Saving changes
Needs the 'Manage Roles' permission.
Nothing is saved until you click "Save Changes" at the bottom. On a predefined role it saves the name and the description; on a custom role also the permissions. "Cancel" goes back to the role list without saving. Leaving the page with unsaved changes asks you to confirm first.
Saving a name that another role already uses is refused with "A role named '…' already exists".
To delete the role, go back to the role list: the delete button is there.