Access Scope: Organizations and Workspaces
On this page
A security role's access scope limits the records its permissions reach. The scope has two independent parts, both stored on the role:
- Organization scope: the role's permissions apply only inside the organizations the role names. The role can additionally count each member's own organization as in scope.
- Workspace scope: the role sees only records in the workspaces the role lists.
A role can be restricted by organization, by workspace, by both, or by neither. You set a role's access scope in the Settings App or in the Admin Center; both edit the same role, and both manage the same list of workspaces. For how roles and permissions work and where roles are administered, see Security Roles. Security roles, and with them access scope, do not apply to Self Service Portal customers.
Before you begin
- To manage the workspace list or a role's access scope in the Settings App, you sign in to the Settings App, which needs Basic Administrative Access. Without it, sign-in is refused with "You do not have enough permissions to use this function."; under automatic sign-in, the Settings App asks you to sign in again instead.
- In the Settings App, the Workspaces node, the Users & Security node, and every node under it, Roles included, show only to holders of the Security Management permission or of Administrative Access. Security Management is one permission for all of these nodes, so whoever manages workspaces there also manages accounts and roles; see Permissions Reference. Opening a hidden node by other means shows "You do not have enough permissions to view this item."
- In the Admin Center, the menu shows the Users & Security section, whose first page is Accounts and Roles, only to holders of Security Management or Administrative Access.
- In the Admin Center, the Workspaces page has an administrative permission of its own. Holding Administrative Access also passes that check.
- Every database has the workspace IT, a system workspace. Neither the Settings App nor the Admin Center deletes it; see Delete workspaces and Manage the workspace list.
In the Settings App
The workspace list is under General > Workspaces. It is sorted by the order you set and then by name, and a record's Workspace field offers the active workspaces in the same order.
Add a workspace
- Go to General > Workspaces.
- Click New, or press Insert. The New Workspaces window opens.
- Enter the name in Workspace. Active is selected for a new workspace.
- Optionally, fill in Tags, free keywords for filtering. Tags has a Manage command.
- Click OK. OK stays disabled while the name is blank.
The new workspace is added at the end of the list.
To limit the workspaces a form's Workspace field offers, write a condition on the workspace tags in that field's filter, in the Settings App's Form Field window.
Edit a workspace
- Select the workspace and click Edit, or double-click it, or press Enter. The Workspaces window opens.
- Change the name, Active, or the tags.
- Click OK.
Change the order of workspaces
- Select a workspace and click Move Up or Move Down, or press Ctrl+Up or Ctrl+Down, to swap it with its neighbor.
- Click Sort by Name to sort the whole list by name. The Settings App asks first and warns that sorting resets the existing order. Sort by Name is disabled while the list is filtered.
Deactivate or activate workspaces
Select one or more workspaces and click Deactivate or Activate.
A deactivated workspace can no longer be chosen in a record's Workspace field. Records that already carry it keep it, and a role's workspace list still shows it.
Delete workspaces
- Select one or more workspaces and click Delete, or press Delete.
- Confirm the deletion. When several workspaces are selected, the question gives their number: "Are you sure you want to delete n selected items?"
When several workspaces are selected and every one of them is deleted, the Settings App reports "n of m items have been deleted."
A workspace is not deleted when:
- It is IT. Deleting IT alone is refused with "This is a system record and it cannot be deleted."; when several workspaces are selected, IT is skipped, and the Settings App shows that message instead of the count of deleted items.
- A security role lists it: "Cannot delete this Workspace because it is associated with one or more security roles".
- Records carry it: "Cannot delete the Workspace because it is associated with one or more objects."
Set the access scope of a role
- Go to Users & Security > Accounts and Roles > Roles.
- Select the role and click Edit, or double-click it. The Security Role window opens, with the role's name in its title. For the other tabs of the window, see Security Roles.
- Open the Access Scope tab. It opens on the Workspaces sub-tab; Organizations is the second sub-tab.
- Set the workspaces and the organizations, as described below.
- Click OK.
On the Workspaces sub-tab:
- The list shows every workspace, inactive ones included, and starts with All Workspaces, which is ticked when the role lists no workspace.
- Ticking All Workspaces ticks every workspace. Clearing any workspace clears All Workspaces.
- When you save a role with every workspace ticked, through All Workspaces or one by one, the role reaches every workspace, including workspaces added later.
- A role that leaves at least one workspace unticked reaches only the ticked workspaces. It reaches a workspace added later only after you tick it there.
- Saving a role with no workspace ticked is refused with "Include at least one workspace to the access scope of your security role."
On the Organizations sub-tab:
- Choose Unrestricted access or Restrict access to organizations. Under Unrestricted access, Add, Remove, and the check box are disabled and the list cannot be changed.
- Click Add to open Select Organization, which shows the organizations as a tree; you can select several. Organizations already in the list are skipped. A role restricted to a parent organization does not reach the records of its child organizations.
- Select Allow access to objects within Current User's Organization to count each member's own organization as in scope. A role with this check box selected shows a <User's Organization> row in the list; removing that row clears the check box.
- Select one or more organizations and click Remove. The question is "Are you sure you want to delete the selected item?" for one row, and "Are you sure you want to delete n selected items?" for several.
- Additions and removals are kept in the window until you click OK; Cancel discards them.
- If you restrict the role but list no organization, OK warns "You chose to restrict access to organizations but did not add any organizations. This role will prohibit access to any organization-related objects. Do you want to continue?" Yes saves a role whose permissions reach no record of a type that carries an organization.
In the Admin Center
Manage the workspace list
The workspace list is under General > Workspaces.
- To add a workspace, click New. The New Workspace window opens with Workspace, Active, and Tags. The name takes up to 64 characters; saving without a name shows "This field is required". Active is cleared on a new workspace. Click Ok to save the workspace, or Cancel.
- To edit a workspace, select it and click Edit. In the Edit Workspace window, change the name, Active, or the tags, and click Ok.
- To change the order, select one workspace and click Move Up or Move Down, or drag the workspace to its new place. Move Up is disabled on the first workspace and Move Down on the last. The new order is stored at once, without saving a workspace.
- To delete workspaces, select one or more, click Delete, and confirm. The question is "Are you sure you want to delete the selected item?" (Yes or No); for several workspaces, it gives their number.
- A selected workspace that cannot be deleted gets a message of its own, and
the other selected workspaces are still deleted:
- IT is refused with "This is a system record and it cannot be deleted."
- A workspace that a security role lists or that records carry is refused in the Classifier in use window: "Could not delete "<name>" because it is used by one or more records. Update those records and try again." The message is the same for a role and for records. When other selected workspaces remain, it adds "Would you like to continue deleting the remaining records?"
- Identical messages can be answered together with Yes to all or No to all. When more than one workspace was selected and at least one was sent for deletion, the Admin Center then shows "n of m items have been deleted."
Each workspace can carry tags, free keywords shown in the list's Tags column:
- In a workspace's Tags field, type a tag and press Enter, or pick a suggestion; the suggestions are the tags already used on other workspaces. Text still in the field when you leave it is added as a tag as well, unless the workspace already has that tag. A tag's delete icon removes that tag, Backspace in the empty field removes the last tag, and the clear icon at the end of the field removes every tag. To change a tag, remove it and add the new value. These changes are stored when you save the workspace; Cancel leaves the stored tags as they were.
- The Tags menu on the toolbar changes the tags of the selected
workspaces. New, Delete, Rename, Clear, and Paste store
their change at once, without saving a workspace. Copy needs exactly
one selected workspace, and Paste is available once tags have been
copied. "Add Tag", "Delete Tag", and "Rename Tag" cannot be confirmed until
a tag is chosen.
- New opens "Add Tag", which accepts a new tag or offers the tags seen on the list since the page opened, and adds the tag to each selected workspace that lacks it.
- Delete opens "Delete Tag" and removes the tag from each selected workspace that has it. Rename opens "Rename Tag", removes the tag from each selected workspace that has it, and adds the New Value at the end of that workspace's tags, without checking whether the workspace already carries it; "Rename Tag" cannot be confirmed until New Value is filled. Both offer only the tags of the selected workspaces. When more than one workspace is selected and at least one of them carries the tag, the message "n of m records have been affected." then reports how many of them carried it.
- Clear asks "Are you sure that you want to clear all tags for the selected records?" and on Yes removes every tag from the selected workspaces.
- Copy, with one workspace selected, keeps that workspace's tags. Paste puts them first on each selected workspace, followed by that workspace's own tags that were not copied; a workspace whose tags already start with the copied tags is left as it is. The copied tags are kept until you leave the page or reload it.
Set the access scope of a role
- On the Accounts and Roles page, open the Roles tab and open the role. The role opens as a dialog. For its other tabs, see Security Roles.
- Open the Access Scope tab. It has two sub-tabs: Workspaces and Organizations.
- Set the workspaces and the organizations, as described below.
- Click Ok to save the role.
On the Workspaces sub-tab:
- The list offers only active workspaces. A workspace whose Active check box is cleared, as it is on a new workspace, appears once you select Active for it on the Workspaces page.
- Selecting All Workspaces clears every workspace selected individually, and the workspace check boxes stay disabled while All Workspaces is selected.
- Saving a role with neither All Workspaces nor any workspace selected is refused with "Include at least one workspace to the access scope of your security role."
- When the dialog is opened in view mode, All Workspaces and the workspace check boxes are disabled.
On the Organizations sub-tab:
- Choose Unrestricted access or Restricted access to organizations. Under Unrestricted access, Add, Remove, and the check box are disabled.
- Click Add to open Select Organization, which shows the organizations as a tree. Click one organization and click Ok; Cancel closes the panel without a change. The organization is added to the list, which shows its name, location, and status. An organization already in the list is not added again. To add several organizations, click Add for each.
- Under restricted access, Allow access to objects within Current User's Organization adds the first row, <User's Organization>. Clearing the check box removes that row.
- Select a row and click Remove. The question is "Are you sure you want to delete the selected item?"; Yes removes the row.
- Remove is disabled while no organization other than <User's Organization> is listed. When at least one other organization is listed, selecting the <User's Organization> row and clicking Remove also clears the check box.
How access scope limits records
A permission lets an account reach a record only when all of these hold for the role that grants the permission:
- The permission covers the record. A scoped permission, such as one for records you are the assignee of, covers only the records that meet its condition.
- For a record of a type that has an organization: the role is not restricted to organizations, or the record's organization is one the role names, or the role counts its members' own organizations and the record's organization is yours. Records of the types that have no organization skip this condition; see Organization scope.
- The role is not restricted to workspaces, or the record's workspace is one the role lists. Stock rooms and discovered installations carry no workspace, so this condition is always met for them.
Record lists apply the same conditions, so records outside the scope do not appear in them. This filtering applies to the lists of incidents, problems, change requests, work orders, service requests, project tasks, computers, hardware, networks, documents, assets, configurations, tracked software, software licenses, consumables, persons, organizations, locations, groups, SLAs, services, service catalog items, Knowledge Base articles, approval requests, approval stages, projects, purchase orders, invoices, contracts, vendors, products, stock rules, library items, and reservations.
Three more lists follow rules of their own:
- Announcements: in the Web App, the list shows rows only to a technician who holds Announcement Management; without it, the list opens with no rows. The list applies the workspace condition but not the organization condition. An announcement is listed when one of the technician's roles is not restricted to workspaces or lists the announcement's workspace. This narrows the list only: an announcement the list leaves out can still show in a dashboard widget and open from there.
- Purchase order items: the list shows an item only when the technician may see its purchase order, so the permission, organization, and workspace conditions of the purchase order apply. The item's own workspace does not narrow this list, though it counts when access to the item itself is checked. Within a purchase order, all of its items are listed.
- Vendor products: the list is not filtered. Where the technician may not see the vendor or the product, those columns are empty.
The list of reports does not apply these conditions. A report that names permissions is listed when the technician holds one of them and the license permits that permission; the organizations and workspaces of a role play no part.
A change to a role's access scope reaches record lists at once. Other technicians who are signed in keep the account-wide permission checks they already loaded until their next sign-in; see When a role change takes effect.
Organization scope
- The check compares the record's own organization. A role restricted to a parent organization does not reach the records of its child organizations.
- The check applies only to the types of records that have an organization. It does not apply to library items, contracts, Knowledge Base articles, locations, SLAs, services, reports, groups, reservations, approval stages, approval requests, vendors, products, stock rules, service catalog items, or project tasks.
Workspace scope
- A record's Workspace field offers only active workspaces. A record saved without a workspace is in the IT workspace.
- These records carry a workspace: announcements, approval requests, approval stages, assets, change requests, computers, configurations, consumables, contracts, documents, hardware, incidents, Knowledge Base articles, library items, locations, networks, organizations, persons, purchase orders, purchase order items, problems, products, projects, reservations, service catalog items, service requests, services, SLAs, software licenses, stock rules, project tasks, tracked software, groups, vendor products, vendors, and work orders.
- Stock rooms carry no workspace, so a workspace restriction hides no stock room.
- Discovered installations carry no workspace either.
- A role that lists no workspace reaches every workspace, including workspaces added later.