Skip to main content
Version: 5.2

Role Model Settings

Roles in Search Anywhere Framework are sets of permissions that define user access to system functions and data. They allow for flexible security policy configuration by granting or restricting rights to:

  • cluster management
  • access to indexes and documents
  • viewing and editing system objects

This article describes the following procedures:

  1. Creating a Role
  2. Assigning Permissions and Associating Users with Roles
  3. List of All Permissions

Getting Started with Roles

Navigate to Main Menu - Settings - Security - Rollup jobs, where all available roles will be displayed.

Security roles

To start the process of creating a role for users, click Create Role or click on an existing role to edit it.

Creating a Role

On the creation page, specify the name of the role in the corresponding field and add permissions for the cluster, indices, and scope.

Please note!

Specify a role name that describes its purpose. The role name cannot be changed after creation.

Cluster Permissions

Permissions for the cluster can be set as a group of actions or as individual permissions. Action groups are a list of individual permissions. You can achieve the desired level of security by using some combination of the default permission groups.

Select the required group/permission from the list or create your own permission group by clicking Create New Permission Group.

Security cluster permissions

Index Permissions

Index permissions define the specific actions allowed on particular indexes. By default, no index permissions are granted. Detailed information about index permission names and their descriptions begins in the Index Template Permissions section.

When creating a new role, the index permissions section already contains a list of parameters (Index, Index Permissions, Document-Level Security, Field-Level Security, Anonymization) for the first index permission. You can add new index permissions. To add a new permission, click Add Index Permission:

Security index permissions

To enter data, you need to expand the Index Permission field group. After clicking, you will see the following fields to fill in:

  • Index — In this field, you must specify the name of the index or its pattern using wildcards (For example: test_index_* will match all indices whose name starts with test_index_)

  • Index Permissions — Specifies the permission or group of permissions (see the Permissions section for more details)

  • Document Level Security (optional) — Allows you to restrict the role to a subset of documents. Example of a filter for documents where the filename field contains the value secure_access.log:

    {
    "bool": {
    "must": {
    "match": {
    "filename": "secure_access.log"
    }
    }
    }
    }
  • Field Level Security (optional) — Specify the document fields that the user will be able to see

  • Anonymization (optional) — Specify fields with sensitive data that need to be replaced with random values. This option hashes the field in search results

Editing a Role

To edit a role, click on the role name and on the opened page click the Edit Role button. The role editing page consists of two tabs: Permissions and Mapped Users:

Security roles tabs

On the Permissions tab, you can add permissions for the cluster, indices, and scope. Editing is done in the same way as creation. On the Mapped Users tab, you can add users to the edited role.

To assign a user, go to the Mapped Users tab and click Map user. On the opened page, specify users and backend roles by selecting them from the list or create a new one by clicking the corresponding button.

Security role definition

You can specify both an internal user and a user from Active Directory. After filling in the fields, click Map.

Permissions List

Ingest API Permissions

The Ingest API is a set of functionalities for loading data into the system. Ingest APIs allow you to work with ingest pipelines and ingest processors to process or transform data from various sources and in different formats. Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:admin/ingest/pipeline/deleteDeleting ingest pipelines
cluster:admin/ingest/pipeline/getRetrieving information about ingest pipelines
cluster:admin/ingest/pipeline/put Creating ingest pipelines
cluster:admin/ingest/pipeline/simulateRunning or testing ingest pipelines
cluster:admin/ingest/processor/grok/getAccess to retrieve information about grok processor used in Ingest pipelines.

Asynchronous Search Permissions

Asynchronous Search is a set of functionalities that allow sending search queries to run in the background. Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:admin/opendistro/asynchronous_search/statsMonitoring statistics for executed, completed, and saved asynchronous search queries
cluster:admin/opendistro/asynchronous_search/deleteDeleting asynchronous search queries
cluster:admin/opendistro/asynchronous_search/getRetrieving information about asynchronous search queries
cluster:admin/opendistro/asynchronous_search/submitSubmitting asynchronous search queries

Index State Management Permissions

Index State Management (ISM) is a mechanism for managing the index lifecycle. Using ISM policies, you can automatically manage an index's state based on its condition. Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:admin/opendistro/ism/managedindex/addAdding indexes to the managed (by policies) list
cluster:admin/opendistro/ism/managedindex/changeChanging the list of managed (by policies) indexes
cluster:admin/opendistro/ism/managedindex/removeRemoving indexes from the managed (by policies) list
cluster:admin/opendistro/ism/managedindex/explainRetrieving information about policy operation status
cluster:admin/opendistro/ism/managedindex/retryRetrying failed actions for managed (by policies) indexes
cluster:admin/opendistro/ism/policy/writeCreating and modifying policies
cluster:admin/opendistro/ism/policy/getRetrieving information about policies
cluster:admin/opendistro/ism/policy/searchUsing queries to search for policies
cluster:admin/opendistro/ism/policy/deleteDeleting policies

Cross-cluster Replication Permissions

Cross-cluster replication is a mechanism that allows replicating indexes, mappings, and metadata from one cluster to another. Detailed information is available in theOpenSearch official documentation.

NameDescription
cluster:admin/plugins/replication/autofollow/updateModifying the auto-replication configuration

Reindexing Permissions

Data reindexing is the process of copying documents from one index to another. Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:admin/reindex/rethrottleChanging the data reindexing speed. Detailed information on reindexing is available in the OpenSearch official documentation

Snapshot Repository Permissions

Snapshot repositories are storage for OpenSearch data snapshots. Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:admin/repository/deleteDeleting snapshot repositories
cluster:admin/repository/getRetrieving information about snapshot repositories
cluster:admin/repository/putCreating and modifying snapshot repositories
cluster:admin/repository/verifyVerifying the health of a snapshot repository

Snapshot Permissions

Snapshots are a mechanism for creating full backups of OpenSearch data, including indexes, their mappings, settings, and metadata. Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:admin/snapshot/createCreating snapshots
cluster:admin/snapshot/deleteDeleting snapshots
cluster:admin/snapshot/getRetrieving information about snapshots
cluster:admin/snapshot/restoreRestoring snapshots
cluster:admin/snapshot/statusRetrieving details about specified snapshots during and after their creation
cluster:admin/snapshot/status*Retrieving status details for all snapshots during and after their creation

Shard Allocation Permissions

A shard is the minimum unit of data storage and processing for indexes in OpenSearch. Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:admin/rerouteManaging the allocation of shards across cluster nodes

Painless Script Permissions

Painless scripts are helper scripts that can be used to manipulate documents in an index.

Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:admin/script/deleteDeleting Painless scripts
cluster:admin/script/getRetrieving information about Painless scripts
cluster:admin/script/putCreating and modifying Painless scripts

Task Permissions

A task is any operation performed in a cluster, such as a search query, a data indexing request, etc. Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:admin/tasks/cancelCanceling task execution
cluster:admin/tasks/testTesting tasks

Security Permissions

The Security REST API is an API for working with security settings, including authentication, authorization, roles, users, and other entities. Detailed information is available in the OpenSearch official documentation.

NameDescription
restapi:admin/actiongroupsExecuting Action group API requests
restapi:admin/allowlistExecuting Allowlist API requests
restapi:admin/internalusersExecuting Users API requests
restapi:admin/nodesdnExecuting Distinguished names API requests
restapi:admin/roles Executing Roles API requests
restapi:admin/rolesmappingExecuting Role mappings API requests
restapi:admin/ssl/certs/infoViewing current transport and HTTP certificates
restapi:admin/ssl/certs/reloadReloading current transport and HTTP certificates
restapi:admin/tenantsExecuting Tenants API requests

Monitoring Permissions

Cluster monitoring operations allow viewing the cluster's state but not modifying it. These permissions are used for health checks, performance analysis, problem diagnosis, task tracking, etc.

Detailed information is available in the OpenSearch official documentation.

NameDescription
cluster:monitor/allocation/explainViewing shard allocation information
cluster:monitor/healthViewing cluster status
cluster:monitor/mainBasic cluster status monitoring
cluster:monitor/nodes/hot_threadsAccessing information about "hot" threads on nodes
cluster:monitor/nodes/infoViewing node information
cluster:monitor/nodes/livenessChecking node liveness
cluster:monitor/nodes/statsAccessing node statistics
cluster:monitor/nodes/usageViewing node usage information
cluster:monitor/remote/infoViewing information about remote clusters
cluster:monitor/stateReading the entire cluster state
cluster:monitor/statsAccessing overall cluster statistics
cluster:monitor/taskMonitoring cluster tasks
cluster:monitor/task/getRetrieving information about a specific task
cluster:monitor/tasks/listsViewing the list of running tasks

Index Template Permissions

Index templates are entities that store index settings which are automatically applied to new indexes upon their creation. Detailed information is available in the OpenSearch official documentation.

NameDescription
indices:admin/index_template/deleteDeleting index templates
indices:admin/index_template/getRetrieving information about index templates
indices:admin/index_template/putCreating and modifying index templates
indices:admin/index_template/simulateTesting index templates
indices:admin/index_template/simulate_indexTesting an index template with a specified name

Index Permissions

An index is the primary data structure used to store, organize, and search documents. Detailed information is available in the OpenSearch official documentation.

NameDescription
indices:admin/aliasesAdding, removing, and modifying index aliases
indices:admin/aliases/getRetrieving information about index aliases
indices:admin/analyzeUsing the Analyze API for text analysis
indices:admin/cache/clearClearing index caches
indices:admin/closeClosing indexes. Once closed, adding new documents to these indexes becomes impossible, and searching their documents will not be possible
indices:admin/close*Closing a specific index
indices:admin/createCreating indexes
indices:admin/deleteDeleting indexes
indices:admin/getRetrieving information about indexes
indices:admin/data_stream/createCreating a data stream
indices:admin/data_stream/deleteDeleting a data stream
indices:admin/data_stream/getRetrieving information about data streams
indices:admin/existsUsing exists queries to search for documents, containing a specific field
indices:admin/flushFlushing indexes
indices:admin/flush*Flushing a specific index
indices:admin/forcemergeForce-merging indexes and data streams
indices:admin/mapping/putCreating and modifying mapping in indexes
indices:admin/mappings/fields/getRetrieving information about index mapping fields
indices:admin/mappings/fields/get*Retrieving information about a specific index's mapping fields
indices:admin/mappings/getRetrieving information about index mapping
indices:admin/openOpening closed indexes
indices:admin/plugins/replication/index/setup/validateValidating the connection to a remote cluster before setting up replication
indices:admin/plugins/replication/index/startStarting cross-cluster replication
indices:admin/plugins/replication/index/pausePausing cross-cluster replication
indices:admin/plugins/replication/index/resumeResuming cross-cluster replication
indices:admin/plugins/replication/index/stopStopping cross-cluster replication
indices:admin/plugins/replication/index/updateModifying cross-cluster replication settings
indices:admin/plugins/replication/index/status_checkChecking the status of cross-cluster replication
indices:admin/refreshRefreshing indexes, making new changes in the indexes visible to search operations
indices:admin/refresh*Refreshing a specific index, making new changes in the index visible to search operations
indices:admin/resolve/indexResolving index names, aliases, and data streams
indices:admin/rolloverPerforming a rollover action for indexes
indices:admin/seq_no/global_checkpoint_syncAllowing synchronization of the global checkpoint in index shards
indices:admin/settings/updateModifying index settings
indices:admin/shards/search_shardsPerforming cross-cluster search
indices:admin/upgradePerforming index upgrade operations to new data formats (controlling execution speed, checking operation status, canceling upgrades)
indices:admin/validate/queryAllows validating the correctness and validity of OpenSearch queries (Query DSL, SQL queries, Painless scripts) before their execution
indices:data/read/explainExecuting Explain API queries, which shows how the relevance score (_score) is calculated for each search result
indices:data/read/field_capsExecuting Field Capabilities API queries, which provides meta-information about index fields
indices:data/read/field_caps*Executing Field Capabilities API queries, which provides meta-information about the fields of a specific index
indices:data/read/getReading index documents
indices:data/read/mgetPerforming multiple document read operations in a single request
indices:data/read/mget*Performing multiple document read operations in a single request. This must be configured as both a cluster-level and index-level permission
indices:data/read/msearchExecuting multiple search queries in a single reques. This must be configured as both a cluster-level and index-level permission
indices:data/read/msearch/templateCombining multiple search templates and sending them to the OpenSearch cluster in a single request. This must be configured as both a cluster-level and index-level permission
indices:data/read/plugins/replication/file_chunkVerifying files during segment replication
indices:data/read/plugins/replication/changesMaking changes to segment replication settings
indices:data/read/scrollScrolling through data. This must be configured as both a cluster-level and index-level permission
indices:data/read/scroll/clearDeleting a scroll context. This must be configured as both a cluster-level and index-level permission
indices:data/read/searchSearching index documents
indices:data/read/search*Searching documents of a specific index
indices:data/read/search/templateReading a search template
indices:data/read/tvRetrieving information and statistics about terms in the fields of a specific document
indices:data/write/deleteDeleting documents
indices:data/write/delete/byqueryDeleting all documents matching a query
indices:data/write/plugins/replication/changesModifying configurations and settings for data replication in indexes
indices:data/write/bulkExecuting a bulk request. This must be configured as both a cluster-level and index-level permission
indices:data/write/bulk*Executing a bulk request. This must be configured as both a cluster-level and index-level permission
indices:data/write/indexAdding documents to existing indexes
indices:data/write/updateMaking changes to individual index documents without a complete overwrite
indices:data/write/update/byqueryRunning a script to update all documents matching a query
indices:monitor/data_stream/statsRetrieving statistics for data streams
indices:monitor/recoveryAccessing recovery statistics
indices:monitor/segmentsAccessing segment statistics
indices:monitor/settings/getReading index settings and configurations
indices:monitor/shard_storesAccessing statistics about shard status at the storage level
indices:monitor/statsAccessing general index statistics
indices:monitor/upgradeAccessing index upgrade statistics

Action Groups

Main Group

NameDescriptionPermissions
unlimitedGrants full (unlimited) access to all action groups. Can be used at the cluster or index level. Equivalent to *.*

Cluster Action Groups

NameDescriptionPermissions
cluster_allAll cluster permissions. Equivalent to cluster:*.cluster:*
cluster_monitorAll cluster monitoring permissions. Equivalent to cluster:monitor/*.cluster:monitor/*
cluster_composite_ops_roRead permissions for executing mget, msearch, or mtv type queries, as well as permissions for alias information requests.indices:data/read/mget, indices:data/read/msearch, indices:data/read/mtv, indices:admin/aliases/exists*, indices:admin/aliases/get*, indices:data/read/scroll, indices:admin/resolve/index
cluster_composite_opsSame as cluster_composite_ops_ro, but additionally grants permissions for bulk operations and full alias management access.indices:data/write/bulk, indices:admin/aliases*, indices:data/write/reindex, indices:data/read/mget, indices:data/read/msearch, indices:data/read/mtv, indices:admin/aliases/exists*, indices:admin/aliases/get*, indices:data/read/scroll, indices:admin/resolve/index
manage_snapshotsPermissions for managing snapshots and snapshot repositories.cluster:admin/snapshot/*, cluster:admin/repository/*
cluster_manage_pipelinesPermissions for managing ingest pipelines.cluster:admin/ingest/pipeline/*
cluster_manage_index_templatesPermissions for managing index templates.indices:admin/template/*, indices:admin/index_template/*, cluster:admin/component_template/*

Index Action Groups

NameDescriptionPermissions
indices_allAll permissions for working with indexes. Equivalent to indices:*.indices:*
getPermissions for get and mget operations.indices:data/read/get*, indices:data/read/mget*
readPermissions for reading from an index (search, getting field mappings, get, and mget).indices:data/read*, indices:admin/mappings/fields/get*, indices:admin/resolve/index
writePermissions for creating and updating documents in existing indexes.indices:data/write*, indices:admin/mapping/put
deletePermissions for deleting documents.indices:data/write/delete*
crudCombines the read, write, and delete groups.indices:data/read*, indices:admin/mappings/fields/get*, indices:admin/resolve/index, indices:data/write*, indices:admin/mapping/put
searchPermissions for searching documents, including the Suggest API.indices:data/read/search*, indices:data/read/msearch*, indices:admin/resolve/index, indices:data/read/suggest*
suggestPermissions for using the Suggest API. Included in the read group.indices:data/read/suggest*
create_indexPermissions for creating indexes and mappings.indices:admin/create, indices:admin/mapping/put
indices_monitorPermissions for all index monitoring operations (recovery, segments_info, index_stats, and status).indices:monitor/*
indexA more restricted version of the write group.indices:data/write/index*, indices:data/write/update*, indices:admin/mapping/put, indices:data/write/bulk*
data_accessCombines the crud group with indices:data/.indices:data/*, indices:data/read*, indices:admin/mappings/fields/get*, indices:admin/resolve/index, indices:data/write*, indices:admin/mapping/put
manage_aliasesPermissions for managing aliases.indices:admin/aliases*
manageAll permissions for monitoring and administering indexes.indices:monitor/*, indices:admin/*

Search Anywhere Framework Permissions

General Permissions

NameDescription
cluster:admin/saf/*/*Full access to modify, delete, create, and read objects of all Search Anywhere Framework modules and components
cluster:admin/saf/*/createCreate and delete objects of all Search Anywhere Framework modules and components, excluding index creation and ISM components
cluster:admin/saf/*/read_allRead objects of all Search Anywhere Framework modules and components
cluster:admin/saf/*/write_allModify and delete objects of all Search Anywhere Framework modules and components

Dashboard Permissions

Dashboards are visual panels for data analysis. Detailed information on working with dashboards is available via the link.

NameDescription
cluster:admin/saf/dashboards/createCreate and delete dashboards
cluster:admin/saf/dashboards/read_allRead dashboards
cluster:admin/saf/dashboards/write_allModify and delete dashboards
cluster:admin/saf/dashboards/*Full access to modify, delete, create, and read dashboards

External Data Source Connection Permissions

Connections are configurations for accessing external data sources. Detailed information on working with data source connections is available via the link.

NameDescription
cluster:admin/saf/db/createCreate and delete data source connection configurations
cluster:admin/saf/db/read_allRead data source connection configurations
cluster:admin/saf/db/write_allModify and delete data source connection configurations
cluster:admin/saf/db/*Full access to modify, delete, create, and read data source connection configurations

External Data Source Query Permissions

Queries allow saving and reusing parameters for accessing external data sources. Detailed information on configuring queries for external data sources is available via the link.

NameDescription
cluster:admin/saf/db_queries/createCreate and delete queries for external data sources
cluster:admin/saf/db_queries/read_allRead queries for external data sources
cluster:admin/saf/db_queries/write_allModify and delete queries for external data sources
cluster:admin/saf/db_queries/*Full access to modify, delete, create, and read queries for external data sources

Lookup Permissions

Lookup configurations define the structure and parameters of external data available for search. Each lookup creates a separate index in the cluster. Detailed information on working with lookups is available via the link.

warning

To work with a lookup, explicit rights to the corresponding index must be granted.

NameDescription
cluster:admin/saf/lookups/createCreate and delete lookups
cluster:admin/saf/lookups/read_allRead lookups
cluster:admin/saf/lookups/write_allModify and delete lookups
cluster:admin/saf/lookups/*Full access to modify, delete, create, and read lookups

Macro Permissions

Macros are saved search query fragments that can be embedded into the main SAFL search query text. Detailed information about macros and how to work with them is available via the link.

NameDescription
cluster:admin/sm/macros/createCreating and deleting macros
cluster:admin/sm/macros/read_allReading macros
cluster:admin/sm/macros/write_allModifying and deleting macros
cluster:admin/sm/macros/*Full access to modify, delete, create, and read macros

Script Permissions

Scripts allow executing custom data processing logic during query execution and aggregations. Detailed information on using Painless scripts is available via the link.

NameDescription
cluster:admin/sm/scripts/createCreating and deleting Painless scripts
cluster:admin/sm/scripts/read_allReading Painless scripts
cluster:admin/sm/scripts/write_allModifying and deleting Painless scripts
cluster:admin/sm/scripts/*Full access to modify, delete, create, and read Painless scripts

Search Anywhere Permissions

The Search Anywhere module enables searching across external sources (e.g., ClickHouse or databases). Detailed information on configuring Search Anywhere is available via the link.

NameDescription
cluster:admin/sm/search_anywhere_sources/createCreating and deleting Search Anywhere configurations
cluster:admin/sm/search_anywhere_sources/read_allReading Search Anywhere configurations
cluster:admin/sm/search_anywhere_sources/write_allModifying and deleting Search Anywhere configurations
cluster:admin/sm/search_anywhere_sources/*Full access to modify, delete, create, and read Search Anywhere configurations

Tag Permissions

Tags allow for easy filtering and finding of entities such as jobs, dashboards, or lookups.

NameDescription
cluster:admin/sm/tags/createCreating and deleting tags
cluster:admin/sm/tags/read_allReading tags
cluster:admin/sm/tags/write_allModifying and deleting tags
cluster:admin/sm/tags/*Full access to tags

Job Scheduler Permissions

The Job Scheduler is a Search Anywhere Framework component that allows creating search tasks executed on a schedule. Detailed information on configuring the job scheduler is available via the link.

NameDescription
cluster:admin/sm/job_scheduler/jobs/createCreating and deleting jobs
cluster:admin/sm/job_scheduler/jobs/read_allReading jobs
cluster:admin/sm/job_scheduler/jobs/write_allModifying and deleting jobs
cluster:admin/sm/job_scheduler/jobs/*Full access to modify, delete, create, and read jobs

Job Scheduler Settings Permissions

NameDescription
cluster:admin/sm/jsc_settings/readReading job scheduler settings
cluster:admin/sm/jsc_settings/writeModifying job scheduler settings

API Connection Permissions

Pre-configured API connection settings, used for the api command, allow setting up connections to interact with external sources/storages. Detailed information on configuring API connections is available via the link.

NameDescription
cluster:admin/sm/api_connection/createCreating and deleting API connection configurations
cluster:admin/sm/api_connection/read_allReading API connection configurations
cluster:admin/sm/api_connection/write_allModifying and deleting API connection configurations
cluster:admin/sm/api_connection/*Full access to modify, delete, create, and read API connection configurations

API Query Permissions

Pre-configured API queries can be used with the api command, simplifying interaction with external sources.

Detailed information on configuring API queries is available via the link.

NameDescription
cluster:admin/sm/api_query/createCreating and deleting API queries
cluster:admin/sm/api_query/read_allReading API queries
cluster:admin/sm/api_query/write_allModifying and deleting API queries
cluster:admin/sm/api_query/*Full access to modify, delete, create, and read API queries

ML Permissions

ML is used to enhance search and data analysis using machine learning algorithms. Detailed information on model training is available via the link.

NameDescription
cluster:admin/sm/ml_models/createCreating and deleting training models
cluster:admin/sm/ml_models/read_allReading training models
cluster:admin/sm/ml_models/write_allModifying and deleting training models
cluster:admin/sm/ml_models/*Full access to modify, delete, create, and read training models

User Limits Permissions

User limits allow setting quantitative restrictions for certain operations, such as the maximum amount of data requested and the maximum search interval.

NameDescription
cluster:admin/sm/limits_user/writeModifying user limit settings

Global Configuration Permissions

The global configuration contains information about the settings of all Search Anywhere Framework components.

NameDescription
cluster:admin/sm/globalconfig/writeGrants permission to use the _core/settings, query, which returns Search Anywhere Framework component settings

Core System Indexes

Index NameWhat the Index ContainsModule
.adhoc_actionsSettings for custom adhoc actions in the Incident ManagerIncident Manager
.sm_dashboardsDashboard definitionsCore / Dashboards Framework
.sm_im_historyIncident work history recordsIncident Manager
.sm_im_settingsIncident Manager module settings (incident card settings, severity settings, etc.)Core / Incident Manager
.sm_incident_aggregation_resultsIncident groups formed by aggregation rulesIncident Manager
.sm_incident_aggsIncident aggregation rule settingsIncident Manager
.sm_inv_categoryInventory category informationInventory
.sm_inv_changes_fieldsContains information about manual overrides of asset field valuesInventory
.sm_inv_configsAsset configuration definitionsInventory
.sm_inv_history_changes-*Information about asset field value changesInventory
.sm_inv_manualInformation about manually created assets. Assets are stored in this index until the calculation module runs, after which assets are moved to the target index specified in the asset configurationInventory
.sm_inv_asset_migrationsInformation about asset migration data from the old calculation algorithm to the new oneInventory
.sm_inv_asset_statsInformation about asset count data in different categories (total assets, manually created, etc.)Inventory
.sm_inv_settingsInformation about lists of settings related to the Inventory moduleInventory
.sm_inv_relation_settingsInformation about asset relationship settingsInventory
.sm_inv_relation_coordinatesInformation about asset coordinates on the canvas showing relationships between assetsInventory
.sm_inv_statistics*Information about asset calculation module run statisticsInventory
.sm_jsc_jobsScheduler job definitionsCore / Job Scheduler
.sm_jsc_recipientsRecipient informationCore / Job Scheduler
.sm_jsc_recipient_groupsRecipient group informationCore / Job Scheduler
.sm_jsc_smtpsSMTP connection configuration informationCore / Job Scheduler
.smos_jdbc_usersDatabase user informationCore / Job Scheduler
.smos_jdbc_connectionsDatabase connection informationCore / Job Scheduler
.smos_jobs_sp_metaMeta-job informationCore / Job Scheduler
sm_throttlingJob throttling informationCore / Job Scheduler
.sm_jsc_settingsJob scheduler settingsCore / Job Scheduler
.sm_ml_modelML ModelsCore / Machine Learning
.sm_modulesSearch Anywhere Framework module informationCore
.sm_nav_settingsSearch Anywhere Framework navigation menu settingsCore
.sm_personsInformation about individual user personalization in the web interface (dark/light theme)Core
.sm_mssp_cluster_clientsCluster client informationCore
.sm_rsm_calculated_metricsCalculated metrics information for the ASM moduleCore / ASM
.sm_rsm_indicatorsASM model indicator definitionsCore / ASM
.sm_rsm_metricsASM model metric definitionsCore / ASM
.sm_rsm_modelsASM model definitionsCore / ASM
.sm_rsm_snapshot-*ASM snapshot informationCore / ASM
.sm_search_favoriteFavorite search query informationCore / Search
.sm_search_historySearch query history informationCore / Search
.smos_metrics-*Information about active action results for metric calculations in the ASMCore / ASM
.smos_risk-*Information about active action Risk Score Assignment resultsUser Behavior Analytics
.smos_mitre-*Information about active action MITRE ATT&CK® Technique Recording resultsMITRE ATT&CK
.smos_incidents*Information about incidents created manually or via the Create Incident active actionIncident Manager
.sm_settingsSearch Anywhere Framework settings informationCore
.sm_sme_dbExternal data source/storage connection configuration informationCore
.sm_sme_db_queriesDatabase query informationCore
.sm_sme_limits_userUser limit informationCore
.sm_sme_lookupsLookup definitionsCore / Lookups
.sm_sme_macrosMacro definitionsCore / Macros
.sm_sme_scriptsPainless script informationCore / Scripts
.sm_sme_search_anywhere_sourcesSearch Anywhere configuration definitionsCore / Search
.sm_sme_api_connectionRemote service HTTP/HTTPS connection configuration informationCore / Search
.sm_sme_api_queryAPI query informationCore / Search
.sm_sme_tagsTag informationCore / Tags
.sm_tag_colorsTag color informationCore / Tags
.sm_scoring_typesScoring type informationCore
.sm_uba_objectsProfiled objectsUser Behavior Analytics
.sm_uba_policiesProfiling policy definitionsUser Behavior Analytics
.sm_uba_objects_latest_scoringScoring information for object cardsUser Behavior Analytics
.sm_uba_whitelistInformation about data that will be mandatory included in profiling resultsUser Behavior Analytics
.sm_uba_fill_objects_configsInformation about object population job configurationsUser Behavior Analytics
.sm_uba_blacklistInformation about blacklisted data that will be excluded from profilingUser Behavior Analytics
.sm_uba_scoring_configsScoring calculation configuration definitions for profiled objectsUser Behavior Analytics
.sm_uba_settingsIndex contains UBA module settings informationUser Behavior Analytics
.sm_uba_types_configsObject type definitionsUser Behavior Analytics
.sm_uba_policies_statistics*Information about UBA policy execution statisticsUser Behavior Analytics
.sm_uba_objects_statistics*Information about UBA object execution statisticsUser Behavior Analytics
.sm_uba_objects_scoring*Information about scoring object listsUser Behavior Analytics
.sm_usersSearch Anywhere Framework user informationCore / Users
.smos_incident-*Incident listIncident Manager
.smos_internal-Scheduler job execution logsCore / Job Scheduler
.smos_wiki_templateWiki page template definitionsCore / Knowledge Center
.sm_kwc_notebookNote informationCore / Knowledge Center
.sm_kwc_caseScenario informationCore / Knowledge Center
.sm_kwc_pageWikilogs page informationCore / Knowledge Center
.sm_kwc_fileInformation about files used on Knowledge center pagesCore / Knowledge Center
.sm_kwc_history_recordHistorical reference informationCore / Knowledge Center
.sm_kwc_sourceData source informationCore / Knowledge Center
.sm_kwc_ruleRule informationCore / Knowledge Center
.sm_kwc_feedFeed informationCore / Knowledge Center
.sm_kwc_dashboardDashboard informationCore / Knowledge Center
.sm_kwc_user_groupUser group informationCore / Knowledge Center
.sm_kwc_permission_groupPermission group informationCore / Knowledge Center
.sm_mitre_object_relationshipsInformation about MITRE object relationshipsMITRE ATT&CK
.sm_mitre_object_tacticsInformation about MITRE tacticsMITRE ATT&CK
.sm_mitre_object_detectionsInformation about MITRE detectionsMITRE ATT&CK
.sm_mitre_object_techniquesInformation about MITRE techniquesMITRE ATT&CK
.sm_mitre_object_data_sourcesInformation about MITRE data sourcesMITRE ATT&CK
.sm_mitre_object_mitigationsInformation about MITRE mitigationsMITRE ATT&CK
.sm_mitre_object_softwareInformation about MITRE softwareMITRE ATT&CK
.sm_mitre_object_proceduresInformation about MITRE proceduresMITRE ATT&CK
.sm_mitre_layersMITRE layer informationMITRE ATT&CK
.sm_mitre_layer_dataInformation about layer data regarding priority, coverage, tactic and technique triggersMITRE ATT&CK
.sm_rsm_v2_layersASM layer informationCore / ASM
.sm_rsm_v2_servicesService informationCore / ASM
.sm_rsm_v2_metricsMetric informationCore / ASM
.sm_rsm_v2_calculated_metrics*Metric calculation informationCore / ASM
.sm_rsm_v2_calculated_metric_entities*Object metric calculation informationCore / ASM
.sm_rsm_v2_calculated_service_health*Service health calculation informationCore / ASM