Documentation
Quickstart
Search Guard Versions
Installing Search Guard
TLS Setup
Search Guard Configuration
Authentication
Authorization
Document- and Field-Level Security
Audit And Compliance Logging
REST API
Kibana
Signals Alerting
Automated Index Management
How Automated Index Management Works
Conditions
Conditions Overview
Age Condition
Doc Count Condition
Size Condition
Actions
Actions Overview
Allocation Action
Close Action
Delete Action
Force Merge Action
Rollover Action
Set Priority Action
Set Read Only Action
Set Replica Count Action
Snapshot Action
REST API
Put Policy
Get Policy
Delete Policy
Policy Instance State
Policy Instance Execute
Policy Instance Retry
Put Settings
Get Settings
Delete Settings
Security Integration
Settings
Integrating with the Elasticstack
Other integrations
Advanced system integrator features
Troubleshooting
Search Guard logging
TLS troubleshooting
User and roles troubleshooting
Permissions troubleshooting
Kibana Troubleshooting
Multi-Tenancy Troubleshooting
Changelogs
Search Guard
Kibana
TLS Tool
Versions
Search Guard FLX
Search Guard 7.x-53
Search Guard 7.x-52
Search Guard 7.x-51
Search Guard 7.x-50
Search Guard 7.x-49
Search Guard 7.x-48
Search Guard 7.x-47
Search Guard 7.x-46
Search Guard 7.x-45
Search Guard 7.x-43
Search Guard 7.x-42
Search Guard 7.x-41
Search Guard 7.x-40
Search Guard 7.x-38
Search Guard 7.x-37
Search Guard 7.x-36
Search Guard 7.x-35
Search Guard 6.x-25
Search Guard 6.x-24
Search Guard 6.x-23
Search Guard 6.x-22
Search Guard 6.x-21
Search Guard 6.x-20
Search Guard 5
Search Guard 2
Forum
Contact Us
Introduction to Search Guard
Overview
Main concepts
Quickstart
Demo Installer (Linux/Mac)
Manual Installation
Guided Tour: Search Guard Basics
Adding users
Configuring roles and permissions
Mapping users to Search Guard roles
Testing the configuration
Search Guard Versions
Latest Releases
Community Edition
Enterprise and Compliance Edition
Academic and Scientific Licensing
OEM Licenses
Search Guard end of life policy
Installing Search Guard
Search Guard Installation
Upgrade Search Guard FLX to 2.0.0
Updating Search Guard
Migrating to FLX
Overview
Quick Start
Production
FLX release notes
Feature map
Upgrade to Search Guard FLX for Elasticsearch 8
Disabling or Removing Search Guard
Search Guard Compatibility
TLS Setup
Generating certificates
Search Guard Installer
Offline TLS Tool
Configuring TLS
Production environments
Certificate revocation
TLS hot-reload
Search Guard Configuration
Overview
Using sgctl
Basic Usage
Examples
Configuration changes
System Administration
Search Guard configuration GUI
Configuration variables
Configuration index maintenance
Authentication
Overview
General configuration
Introduction to sg_authc
Advanced user mapping
Other advanced options
Password-based authentication
Overview
Internal users database
Active Directory and LDAP
Quick Start
Advanced Configuration
Kerberos / SPNEGO
JWT
Quick Start
Advanced Configuration
Proxy authentication
Quick Start
Advanced Configuration
Client certificate authentication
Anonymous authentication
Search Guard Auth Tokens
Authorization
Demo users and roles
Mapping users to Search Guard roles
Permissions and action groups
Search Guard roles
Search Guard roles (2.x and below)
Role mapping modes
Runtime index privilege evaluation
Advanced topics
User impersonation
Snapshot and restore
Document- and Field-Level Security
Document-level security
Basics
Attribute-based authorization
Advanced topics
Field-level security
Field anonymization
Audit And Compliance Logging
Configuring Audit Logging
Storage Types
Compliance event routing
Field Reference
Read History Audit Logging
Write History Audit Logging
Configuration change tracking
System change tracking
Immutable indices
REST API
Access Control
Usage and return values
Reserved and hidden resources
Internal users API
Roles API
Roles mapping API
Action groups API
Blocks API
Tenants API
License API
Cache API
REST API - Bulk Requests
Kibana
Installing the Plugin
Authentication
Overview
Password based authentication
Quick Start
Customizing the login page
OIDC
Quick Start
Advanced Configuration
SAML
Quick Start
Advanced Configuration
Troubleshooting
Proxy
Kerberos
JWT URL Parameters
Anonymous authentication
Using multiple authentication methods
Troubleshooting
Multi-Tenancy
Read Only mode
Advanced Topics
Using the Kibana API
Kibana in IFrame
Signals Alerting
Getting started with Signals Alerting
How Signals Alerting works
Sample Watches
Execution chain and payload
Alerting Triggers
Triggers Overview
Schedule Triggers
Handling Timezones
Inputs
Inputs Overview
Static Input
Search Input
HTTP Input
Transformations
Transformations Overview
Transformations
Calculations
Conditions
Severity Levels
Actions
Actions Overview
Index Actions
Email Actions
Webhook Actions
Slack Actions
Pagerduty Actions
JIRA Actions
Accounts
Scripting
Throttling and Acknowledgement
Trust Stores
Proxies
REST API
REST API Overview
Get Watch
Put Watch
Delete Watch
Search Watch
Activate and Deactivate Watch
Execute Watch
Acknowledge Watch
Acknowledge And Get
Un-acknowledge Watch
Un-acknowledge Watch And Get
Convert ES Watch
Get Watch State
Search Watch States
Get Account
Put Account
Delete Account
Search Accounts
Create or replace a trust store
Get all trust stores
Get one trust store
Delete trust store
Create or replace a proxy
Get all proxies
Get one proxy
Delete proxy
Get Settings
Put Settings
Activate and Deactivate Tenant
Activate and Deactivate Signals
Security Integration
Security Integration Overview
Signals Indices
Permissions
Execution context
Multi-Tenancy
Status and Logging
Administration
Advanced Topics
Watch overview page query params
Automated Index Management
How Automated Index Management Works
Conditions
Conditions Overview
Age Condition
Doc Count Condition
Size Condition
Actions
Actions Overview
Allocation Action
Close Action
Delete Action
Force Merge Action
Rollover Action
Set Priority Action
Set Read Only Action
Set Replica Count Action
Snapshot Action
REST API
Put Policy
Get Policy
Delete Policy
Policy Instance State
Policy Instance Execute
Policy Instance Retry
Put Settings
Get Settings
Delete Settings
Security Integration
Settings
Integrating with the Elasticstack
Logstash
Cross Cluster Search
X-Pack Monitoring
X-Pack Alerting
X-Pack Machine Learning
X-Pack Alternatives
Elastalert
Other integrations
Fluentd
Cerebro
Grafana
Advanced system integrator features
SSL only mode
Search Guard index restore
Inter-node traffic evaluator
Custom Principal Extractor
Injecting an SSLContext
Version: SG FLX
Enterprise
Kibana OpenID Connect Authentication
Questions? Drop us a note!
Not what you were looking for? Try the search.