Configure users and roles
The Splunk App for Enterprise Security utilizes the Access Control system of Splunk Enterprise. Splunk Enterprise authentication allows you to add users, assign users to roles, and assign those roles custom capabilities as needed for your organization.
Splunk Enterprise supports several methods of user authentication:
- The Splunk Enterprise built-in user authentication system.
- User authentication using LDAP and Active Directory. For more information, see "Set up user authentication with LDAP".
- Scripted authentication API: Use scripted authentication to tie authentication requests to an external authentication system, such as RADIUS or PAM. For more information, see "Set up user authentication with external systems".
- Single Sign-on: For more information, see "About Splunk single sign-on".
Important: The Splunk Enterprise built-in user authentication takes precedence over any configured external authentication.
The Splunk App for Enterprise Security adds three required roles, pre-configured with capabilities. These roles were created to assist in assigning users specific access to functions in the Enterprise Security app. Based upon the information presented below, the admin must assign groups of users to roles that best fit the tasks they will perform and manage within the Enterprise Security app.
|Role||Inherits from role||Added capabilities||Accepts user assignment|
||user||real time search|| Yes.|
Replaces the "user" role for ES users.
||user, ess_user, power|| inherits
Replaces the "power" role for ES users.
||user, ess_user, power, ess_analyst|| inherits
|| No |
Assign users to the "admin" role.
||user, ess_user, power, ess_analyst, ess_admin||All||Yes.|
Important: The ess_admin role is assigned all ES specific capabilities, but does not inherit Splunk Enterprise admin capabilities. You must use the "admin" role to administer an Enterprise Security installation. To change the capabilities of the ess_user or ess_analyst roles, see "Custom capabilities" in this topic.
Configure user roles
There are three categories of users:
- Security Director: Reviews the Security Posture, Protection Centers, and Audit dashboards in order to understand current Security Posture of the organization. A security director will not configure the product or manage incidents.
- Security Analyst: Uses the Security Posture and Incident Review dashboards to manage and investigate Security Incidents. Security Analysts are also responsible for reviewing the Protection Centers and providing direction on what constitutes a security incident. They will also define the thresholds used by correlation searches and dashboards. A Security Analyst needs to be able to edit correlation searches and create suppressions.
- Solution Administrator: Installs and maintains Splunk Enterprise and Splunk Apps. This user is responsible for configuring workflows, on-boarding new data sources, and tuning and troubleshooting the application.
Each user type requires different levels of access to perform their assigned functions. The table below shows the user category matched to an Enterprise Security role.
|Role||Security Director||Security Analyst||Solution Administrator|
All role inheritance is pre-configured in the Enterprise Security app. If the capabilities of any role are changed, other roles will also inherit the changes. The best method to assess the pre-configured roles, capabilities, and inheritance in the Enterprise Security app is to review the
authorize.conf file in
The Enterprise Security app implements new, ES specific features in Splunk Enterprise. To control access to those features, additional capabilities have been created and assigned to the Enterprise Security specific roles.
The table displays all ES specific capabilities. To customize a role and add access to Enterprise Security features, add the capabilities listed and modify the app metadata files to add the role name.
|ES Feature||Capabilities required||Additional metadata changes|
|Correlation searches|| edit_correlationsearches
| In apps:|
|Log review settings||edit_log_review_settings||No|
|Edit Lookups||edit_lookups|| In apps:|
|Manage Lookups||edit_lookups|| In apps:|
access = read : [ * ], write : [ admin,role1,role2 ]
|Navigation||edit_es_navigation||In app: |
|Edit Notable Events|| edit_tcp
transition_reviewstatus-X to Y
|New Notable Events|| edit_tcp
|Own Notable Events||can_own_notable_events||No|
| Advanced Filter or
|Review Statuses||edit_reviewstatuses||In apps:|
Adjust the concurrent searches for a role
Splunk Enterprise defines a limit on searches to be run concurrently for
power roles by default. After Enterprise Security is installed, increase the limits for roles other than
To further increase the number of concurrent searches for a role:
- Click Apps > Manage Apps.
- Click Setup next to Enterprise Security.
- Change the number of concurrent searches for the role and save.
To change the default search quota manually, edit the
- Edit the file at
srchJobsQuotafor each role.
[role_user] srchJobsQuota = 15
Configure the roles to search multiple indexes
Data sources being ingested by Splunk Enterprise are stored in multiple indexes. Multiple indexes are used to control access to data and to accommodate varying retention policies in data sources.
By default, all roles are configured to search only in the
main index as the default. To enable the searching of multiple indexes, you must manually assign the indexes that contain relevant security data to all ES roles. If the roles are not updated, searches and other knowledge objects that rely on search results will not reflect the data from unassigned indexes.
Note: When adding indexes to a role, default search indexes must not include summary indexes, as this can cause a search and summary index loop.
This documentation applies to the following versions of Splunk® Enterprise Security: 3.3.0, 3.3.1, 3.3.2, 3.3.3