WARNING: Version 6.0 of Heartbeat has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Granting Users Access to Heartbeat Indices
editGranting Users Access to Heartbeat Indices
editTo enable users to access the indices a Heartbeat creates, grant them read
and view_index_metadata
privileges on the Heartbeat indices:
-
Create a role that has the
read
andview_index_metadata
privileges for the Heartbeat indices. You can create roles from the Management > Roles UI in Kibana or through therole
API. For example, the following request creates aheartbeat_reader
role: -
Assign your users the reader role so they can access the Heartbeat indices:
-
If you’re using the
native
realm, you can assign roles with the Management > Users UI in Kibana or through theuser
API. For example, the following request grantsheartbeat_user
theheartbeat_reader
role:POST /_xpack/security/user/heartbeat_user { "password" : "x-pack-test-password", "roles" : [ "heartbeat_reader"], "full_name" : "Heartbeat User" }
-
If you’re using the LDAP, Active Directory, or PKI realms, you assign the roles in the
role_mapping.yml
configuration file. For example, the following snippet grantsHeartbeat User
theheartbeat_reader
role:heartbeat_reader: - "cn=Heartbeat User,dc=example,dc=com"
For more information, see Using Role Mapping Files.
-