Skip to content
Tutorials Center
My learning

Topics

Lesson 28 of 36 ยท Administration and Indexing

Splunk Users, Roles, Capabilities and Knowledge Object Permissions

Control who can do and see what in Splunk: authentication methods, roles with capabilities and index access, role inheritance, search filters and quotas, and knowledge object sharing.

Splunk holds logs that often contain personal, financial and security-sensitive information, so access control is part of the product, not an afterthought. Three things decide what a person can do: who they are (authentication), which roles they have (authorization) and how objects are shared (permissions on reports, dashboards, lookups and so on). This lesson covers all three.

Authentication

Splunk can authenticate users in several ways:

  • Native (Splunk) authentication: users and password hashes stored in Splunk itself. Fine for a lab and for an emergency admin.
  • LDAP / Active Directory: map directory groups to Splunk roles. Users sign in with their directory credentials; Splunk periodically syncs group membership.
  • SAML single sign-on: an identity provider (Azure AD / Entra ID, Okta, Ping and others) authenticates the user and sends group attributes that map to roles. Supports MFA through the provider.
  • Scripted authentication: a custom script for unusual systems.
  • Proxy / reverse-proxy (trusted header) setups in some deployments.

Configure under Settings > Authentication methods. With external authentication, keep one native admin account as a break-glass login, and protect it with a long random password stored in a vault.

Roles and capabilities

A role is a named set of permissions. Users have one or more roles; the effective rights are the union of their roles' capabilities and index access. The built-in roles are:

Role Intent
admin Full control of the instance
sc_admin Admin role on Splunk Cloud
power Can share objects, schedule searches, use real-time searches
user Can search and save private objects
can_delete Gives the delete_by_keyword capability (powerful and dangerous; not assigned to anyone by default)

A capability is a single permission, for example schedule_search, rtsearch, edit_user, edit_roles, accelerate_datamodel, list_storage_passwords, edit_tokens_all, change_authentication. Capabilities are what the UI checks when it hides a menu.

Create a role in Settings > Roles > New Role and set:

  • Inheritance: inherit capabilities, indexes and settings from other roles (for example user), then add or restrict.
  • Capabilities: add the ones you need.
  • Indexes searched by default: indexes included when a search does not name an index.
  • Indexes searchable: srchIndexesAllowed, the list of indexes the role can read (wildcards allowed, for example web*).
  • Restrictions: search filter (srchFilter), search jobs quota (srchJobsQuota, concurrent searches per user), disk space quota (srchDiskQuota), time range limit (srchTimeWin in seconds), and earliest searchable time (srchTimeEarliest).

In authorize.conf:

INI
[role_helpdesk]
importRoles = user
srchIndexesAllowed = web;app
srchIndexesDefault = app
srchFilter = NOT sourcetype=pci:*
srchJobsQuota = 3
srchTimeWin = 2592000
schedule_search = enabled

A search filter is a hidden condition appended to every search the role runs. Filters of different roles for one user combine with OR (the user sees the union), while restrictive settings such as quotas combine toward the most permissive. Because a filter is only a string appended to the search, it controls rows, not fields: a user who may see events may see all fields of those events. For field-level masking use separate indexes or masking at index time (inputs, props and transforms).

Try it: resolving role inheritance (stand-in)

This stand-in resolves what a user can read, using inheritance and the union of roles.

Python Stand-in: role inheritance and index access

Press Run (or Ctrl + Enter) to see the result here.

Program input ยท what you'd type while the program runs

Type the answers before you press Run, one per line. Each time the program reads a line (with input()), it gets the next line from this box.

Search filters in practice

Suppose the helpdesk role has srchFilter = NOT sourcetype=pci:*. When Dana runs index=app error, Splunk silently runs index=app error NOT sourcetype=pci:*. Filters apply on search; they do not protect data in a data model summary unless acceleration was built under a compatible context, so always test with a restricted test user.

Python Stand-in: apply a role's search filter

Press Run (or Ctrl + Enter) to see the result here.

Program input ยท what you'd type while the program runs

Type the answers before you press Run, one per line. Each time the program reads a line (with input()), it gets the next line from this box.

Knowledge objects and sharing

Knowledge objects are the things you build to make data meaningful: saved searches and reports, alerts, dashboards, field extractions, calculated fields, lookups, event types, tags, macros, data models, workflow actions. Each object has an owner, an app and a sharing level:

  • Private: only the owner.
  • App: everyone with read access in that app; the roles that can write are chosen.
  • Global (All apps): visible across apps.

Change them in Settings > All configurations or from the object's Edit Permissions. Needed capabilities include schedule_search, edit_own_objects and the rights to write in the app. A shared object's results are still limited by the running user's roles: sharing a report never reveals data to someone without access to its index. Scheduled searches run as their owner, so if the owner is deleted, searches orphan; reassign knowledge objects with Settings > All configurations > Reassign Knowledge Objects, or find them with | rest /servicesNS/-/-/saved/searches | search orphaned=1 before removing an account.

Good habits: let users build privately, review and promote useful objects to the app level, name them with prefixes, keep ownership with a service account for production content, and remove unused objects regularly. A lookup or macro that is not shared at the same level as the search that uses it breaks that search for everybody else.

Check your understanding

Quick check ยท 4 questions

of 4 answered You scored / 4 ยท perfect!

  1. 1. If a user has two roles, what are their index permissions?

    Rights from multiple roles are combined, so the user can search every index either role allows.
  2. 2. What does srchFilter do?

    A search filter restricts which events a role sees, but it does not hide individual fields.
  3. 3. Which sharing level makes a report visible only to its owner?

    Private objects are visible to the owner only; App and Global (All apps) widen the audience.
  4. 4. Why keep a native admin account when using SAML?

    If the identity provider fails you still need a way to sign in and fix the configuration.

Summary

  • Authenticate natively, with LDAP, SAML (with MFA) or scripts; keep a break-glass admin.
  • Roles bundle capabilities, index access and search limits; they can inherit and combine by union.
  • Search filters, job quotas and time-range limits restrict what a role can do.
  • Knowledge objects are Private, App or Global; data access always follows the running user's roles.
  • Reassign orphaned objects before deleting users.

Next: Monitoring and troubleshooting Splunk