User Privilege System

Administrators can control each user's access to various resources of CIRCUS via the privilege system. This page describes the basic concepts of CIRCUS's user management and the privilege system.

Users and Groups#

Each user belongs to one or more groups. The privileges of a user are granted indirectly by the groups they belong to. (Technically, there can be a user who belongs to no group, in which case that user can do virtually nothing other than logging-in and seeing their profile.)

When you have finished installing CIRCUS, you have the following two predefined groups:

admin
Has all privileges needed for management tasks.
users
Has only a limited number of privileges.

As an administrator, you can change the privileges of these groups arbitrarily (including the group name), or create a new group that suits your needs.

After the installation, you have one predefined user (circus), which belongs to the admin group.

Global Privileges#

Global privileges are a set of roles that can be assigned to groups via Group Settings.

manageServer
The "administrator" global privilege. A user with this privilege can perform administrative tasks such as adding users.
personalInfoView
A user with this privilege can view a patient's personal information (name, age, etc.).
downloadVolume
A user with this privilege can download DICOM series uploaded to CIRCUS. (Note that, since CIRCUS is a web-based system, a knowledgeable user may still download volumes without this privilege as long as they can view that series.)
issueOnetime
A user with this privilege can issue a onetime URL that allows a user to log in without a password.

Global privileges are granted additively when a user belongs to multiple groups. For example, if a user belongs to both Group A with personalInfoView and Group B without it, this user will have the personalInfoView global privilege.

Resource-specific Privileges#

Series#

Each DICOM series imported (uploaded) to CIRCUS will have a string label called domain. Domains allow you to control which users have access to which series.

Unlike users, a series must belong to precisely one domain. A series cannot be imported without a domain, and a series cannot belong to more than one domain.

The list of available domains must first be declared via Server Configuration. The default domain is the only predefined domain.

To grant access to DICOM series to a user, go to Group Settings first, change the list of accessible domains of a group, and make the user belong to the group.

A domain does not necessarily have to follow the format of internet domains (e.g., "foo.bar.net"), but this is usually a reasonable convention to avoid any future collision.

Cases (CIRCUS DB)#

CIRCUS DB's cases have an additional layer of access control based on the project it belongs to. For details, see Group Settings.

Plug-in Jobs (CIRCUS CS)#

Currently, a user can access the data for any plug-in job as long as they have access to the processed series in the job (based on the domain rule described above). You cannot control the visibility of a specific plug-in or plug-in job based on a user or a group. In the future, a plug-in-based access control system (similar to the project-based access control of CIRCUS DB) may be added.

Personal Information Protection#

Personal Information refers to the following personal information contained in DICOM tags:

  • Patient ID
  • Patient name
  • Patient sex
  • Patient age
  • Patient weight/height

In CIRCUS, the visibility of personal information is controlled in three layers:

  1. All users wishing to access patient information must have the showPersonalInfo global privilege. A user without this privilege will not have access to any patient information whatsoever.
  2. Each resource type (series, cases, plugin jobs) has additional rules to restrict access to personal information. The rule depends on the resource type.
  3. Finally, even when a user has access to view personal information, he/she can arbitrarily hide personal information temporarily (See Preference). This is useful for demonstration or some blind testing.

When a user cannot access personal information, they cannot perform a search with personal information, either. For example, they cannot search for a patient even when they know the exact patient ID of a series.