Splunk® Enterprise

Reporting Manual

Download manual as PDF

Download topic as PDF

Set report permissions

Any report you create is initially private and only available to you. If the capabilities granted to you by your role allow it, you can change the report permissions to share it with others.

Prerequisites


Steps

  1. Open the Edit Permissions dialog for your report.
    There are a number of ways that you can access the Edit Permissions dialog:
    Access method For existing reports? Access steps
    When you first create the report No
    1. Run a search.
    2. Save the search as a report.
    3. On the Your Report Has Been Created dialog, click Permissions.
    From the Reports listing page Yes
    1. Navigate to the Reports listing page.
    2. Locate the report that you want to edit permissions for.
    3. Click Edit, and select Permissions.
    From the report display view Yes
    1. Navigate to the Reports listing page.
    2. Find the name of the report and click it to open the report.
    3. Click Edit and select Edit permissions.
    From Settings Yes
    1. Navigate to Settings > Searches, Reports, and Alerts.
    2. Locate the report that needs to have its permissions edited.
    3. Click its Permissions link.

  2. Select either App or All apps.
    All reports are created in the context of a specific app.
    • Select App to share the report with other users of the app that the report belongs to.
    • Select All apps to share the report with all users of your Splunk platform implementation.
    Selecting App or All apps exposes the Run as field and role permissions settings.

  3. (Optional) Determine whether the report runs as Owner or User.
    This setting determines whether the search runs with the permissions of the search Owner (the person who defined the search) or the permissions of the search User (the person who is running the search). Reports run as Owner by default.
    You do not see the Owner and User controls when you set permissions from the Searches, Reports, and Alerts page in Settings. They instead appear in the detail page for the report.

  4. Set the Read and Write permissions by role.
    Read gives a user with the selected role the ability to see and run the report, but they cannot edit it. Write gives the user the ability to run and edit the report if they wish. If you leave these settings unmarked for a particular role, that role cannot see the report.

  5. Click Save to save your permissions changes.

Determine whether to run reports as the report owner or report user

When you share a report with other users, you have the option of having it run with the permissions of the report "owner" (the person who created the report) or the report "user" (the person who is running the report). This setting is used for two reasons:

  • It can allow access to search data that might otherwise be unavailable to the person running the report.
  • It helps prevent situations where your concurrent search limit is reached when too many people run reports that you own.

All reports run as Owner by default.

Note: Scheduled reports can only run as Owner. If you share a report so that it runs as User and then schedule that report, its permissions change to run as Owner.

The Owner and User settings can also affect the way your users interact with dashboards with panels that are backed by reports. See Add panels to dashboards in the Dashboards and Visualizations Manual.

Control access to report results

The Owner and User settings let you control access to the data returned by your reports. For example, say you have an index that is restricted to users with the Admin role. When a person with the Admin role writes a search that accesses events in this index and then shares it as a report that runs as Owner, any user with a lesser role can run it and see the events from the restricted index, because the report runs as if its Admin role owner ran it. This might be the desired outcome, if the Admin user wants to expose certain aspects of otherwise restricted data to users with lesser permissions.

If the Admin shares the report so it runs as User, anyone can run it, but when they do, the report runs with their permissions, not those of the report owner. So if you have the User role and you run the report, the report cannot return events from the restricted index, because your permissions are not as strong as those of the report owner.

Keep concurrent search job limits for report owners from being exceeded

The Owner and User controls determine whether a run of the report counts against the concurrent search job limit of the report "owner" or the report "user." These limits vary by role and are set in Settings > Access controls > Roles > <name of role>. You may want to have a shared report run as User so that your concurrent search limit isn't reached when other users run the report at the same time.

For example, by default, a person with the Admin role can run 50 search jobs concurrently. It is highly unlikely that an Admin user would run more than 50 jobs at the same time, but if they did, any additional jobs would be queued up by the report scheduler to run later.

Now imagine that you have the Admin role. You run a search, save it as a report, and share it to run as Owner. Later, someone else builds a dashboard and uses your report to back one of the panels. If this dashboard is especially popular, you could run into a situation where you find that your concurrent search limit is constantly being hit because that dashboard loaded or reloaded by large numbers of users. To solve this problem you would edit the permissions for the report so that it runs as User.

Permissions for Pivot-based reports

Permissions for reports built in Pivot cannot exceed those of the data model that the report references. For example, you cannot share a report to users of all apps if it references a private data model. If you try to do this you will receive an error message. You must first share the data model referenced by the report to users of all apps, and then set the report permissions accordingly. For more information about sharing data models, see Manage data models in the Knowledge Manager Manual.

Here is a slightly more complex example. Your Splunk deployment has two apps installed: Search and Security. When you are in the context of the Security app, you use its External Threats data model to create a Pivot-based report titled "Top Firewall Attacks by IP." The External Threats data model has permissions that are scoped to the Security app, and nothing more.

When you first create the report, its permissions are set to Owner, which means that you are the only person who can see the report and update it. You want everyone to see the "Top Firewall Attacks by IP" report, regardless of app context, so you change its permissions to All apps. Now, when you switch your app context to the Search app, you might expect to be able to access "Top Firewall Attacks by IP" from the Search app.

However, you cannot view it from the Search app. This is because the report is based on the External Threats data model, and that data model's permissions are still scoped to the Security app. To access and run the "Top Firewall Threats by IP" report from the Search app, share the External Threats data model globally by setting its permissions to All apps.

PREVIOUS
Create and edit reports
  NEXT
Accelerate reports

This documentation applies to the following versions of Splunk® Enterprise: 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.6.0, 6.6.1, 6.6.2, 6.6.3


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters