Using Access Keys with User-generated Content

Download this manual as a PDF file

You can use Access Keys to restrict access to user-defined content, specifically dashboards and device groups. Each dashboard or device group can have an associated Access Key that controls user access. The following sections describe how to use Access Keys with each type of content.

You can create dedicated Access Keys that provide access only to user-defined, shared content by creating an Access Key without any aligned Access Hooks.

Use the following menu options to navigate the SL1 user interface:

  • To view a pop-out list of menu options, click the menu icon ().
  • To view a page containing all the menu options, click the Advanced menu icon ().

This section includes the following topics:

Using Access Keys with Dashboards

To share a classic dashboard with users, you must configure the Access Control for the dashboard to permit other organizations to use it.

To edit a classic dashboard:

  1. Open the dashboard you want to configure on the Dashboards tab.
  2. Click Actions and select Configure Dashboard. The Dashboard Settings modal opens.
  3. Set Access Control to Share with organizations.
  4. Select one or more Access Keys to grant access to the dashboard as needed.

NOTE: For more information on dashboards, see Dashboards.

When you define the dashboard as shared, the Access Keys field will become active. Access Keys in the "EM7 System Administration" and "Dashboards" categories will appear in the Required Keys select field. You can select any number of keys from the Required Keys select field.

A user must meet the following criteria to use a dashboard controlled by an Access Key:

  • The user must have at least one of the Access Keys selected in the Required Keys select field for the Dashboard. If no Access Keys are selected, any user meeting the following two requirements may access the dashboard.
  • The user must be granted an Access Key that includes the "Dash:View" and "Dash:View Shared" Access Hooks.
  • The user and the creator of the Dashboard must be members of the same organization.

If a user meets the above requirements and also has been granted an Access Key that includes the "Dash:Edit Shared" Access Hook, that user will be able to edit the shared Dashboard. If a user has been granted an Access Key that includes the "Dash:Add/Rem Shared" Access Hook, that user may delete shared Dashboards.

Using Access Keys with Device Groups

To share a device group with users, you must select the "yes" option in the Shared (visible to all users) radio button group when creating or editing a device group:

NOTE: For details on device groups, see Device Groups and Device Templates.

The Permission Keys select field will become active when "yes" is selected. Access Keys in the "EM7 System Administration" and "Device Groups" categories will appear in the Permission Keys select field. You can select any number of keys from the Permission Keys select field.

A user must meet the following criteria to use an Access Key controlled device group:

  • The user must have at least one of the Access Keys selected in the Permission Keys select field for the device group. If no Access Keys are selected, any user meeting the following two requirements will be able to access the device group.
  • The user must have the Registry> and Registry>Devices>Groups Access Hooks aligned with one of their granted Access Keys
  • The user and creator of the device group must be members of the same organization.

If a user has the DevGroup:Edit Access Hook aligned with one of their granted Access Keys in addition to meeting the above requirements, they will be able to edit the shared device group.

Generating a Report for an Access Key

From the Access Keys page you can generate a report on any access key in SL1. The report displays the hook category, hook ID, and hook name of each access hook included in the access key.

To generate a report on access keys:

  • Navigate to the Access Keys page (System > Manage > Access Keys).

  • Locate the access key for which you want to generate a report and click its wrench icon ():

  • The Key/Hook Alignment Editor modal page appears. Click the Report button:

  • The Export key definition as a report modal page appears:

Select from the following output formats to generate the report:

  • Web page (.html)
  • OpenDocument Spreadsheet (.ods)
  • Excel Spreadsheet (.xlsx)
  • Acrobat Document (.pdf)
  • Click the Generate button to generate the report. If you selected the Force browser to save to disk checkbox on the Export key definition as a report modal page, you will be promoted to designate a location to save the report before you can view the report.