The Open Distro project is archived. Open Distro development has moved to OpenSearch. The Open Distro plugins will continue to work with legacy versions of Elasticsearch OSS, but we recommend upgrading to OpenSearch to take advantage of the latest features and improvements.
Tenants in Kibana are spaces for saving index patterns, visualizations, dashboards, and other Kibana objects. By default, all Kibana users have access to two tenants: Private and Global. The global tenant is shared between every Kibana user. The private tenant is exclusive to each user and can’t be shared.
Tenants are useful for safely sharing your work with other Kibana users. You can control which roles have access to a tenant and whether those roles have read or write access.
You might use the private tenant for exploratory work, create detailed visualizations with your team in an
analysts tenant, and maintain a summary dashboard for corporate leadership in an
If you share a visualization or dashboard with someone, you can see that the URL includes the tenant:
Multi-tenancy is enabled by default, but you can disable it or change its settings using
config: dynamic: kibana: multitenancy_enabled: true server_username: kibanaserver index: '.kibana' do_not_fail_on_forbidden: false
| ||Enable or disable multi-tenancy. Default is true.|
| ||Must match the name of the Kibana server user from |
| ||Must match the name of the Kibana index from |
| ||If true, the security plugin removes any content that a user is not allowed to see from search results. If false, the plugin returns a security exception. Default is false.|
kibana.yml has some additional settings:
elasticsearch.username: kibanaserver elasticsearch.password: kibanaserver elasticsearch.requestHeadersWhitelist: ["securitytenant","Authorization"] opendistro_security.multitenancy.enabled: true opendistro_security.multitenancy.tenants.enable_global: true opendistro_security.multitenancy.tenants.enable_private: true opendistro_security.multitenancy.tenants.preferred: ["Private", "Global"] opendistro_security.multitenancy.enable_filter: false
| ||Kibana requires that you whitelist all HTTP headers that it passes to Elasticsearch. Multi-tenancy uses a specific header, |
| ||Enables or disables multi-tenancy in Kibana. Default is true.|
| ||Enables or disables the global tenant. Default is true.|
| ||Enables or disables the private tenant. Default is true.|
| ||Lets you change ordering in the Tenants tab of Kibana. By default, the list starts with global and private (if enabled) and then proceeds alphabetically. You can add tenants here to move them to the top of the list.|
| ||If you have many tenants, you can add a search bar to the top of the list. Default is false.|
To create tenants, use Kibana, the REST API, or
- Open Kibana.
- Choose Security, Tenants, and Create tenant.
- Give the tenant a name and description.
- Choose Create.
See Create tenant.
--- _meta: type: "tenants" config_version: 2 ## Demo tenants admin_tenant: reserved: false description: "Demo tenant for admin user"
Give roles access to tenants
After creating a tenant, give a role access to it using Kibana, the REST API, or
- Read-write (
kibana_all_write) permissions let the role view and modify objects in the tenant.
- Read-only (
kibana_all_read) permissions let the role view objects, but not modify them.
- Open Kibana.
- Choose Security, Roles, and a role.
- For Tenant permissions, add tenants, press Enter, and give the role read and/or write permissions to it.
See Create role.
--- test-role: reserved: false hidden: false cluster_permissions: - "cluster_composite_ops" - "indices_monitor" index_permissions: - index_patterns: - "movies*" dls: "" fls:  masked_fields:  allowed_actions: - "read" tenant_permissions: - tenant_patterns: - "human_resources" allowed_actions: - "kibana_all_read" static: false _meta: type: "roles" config_version: 2
Manage Kibana indices
The open source version of Kibana saves all objects to a single index:
.kibana. The security plugin uses this index for the global tenant, but separate indices for every other tenant. Each user also has a private tenant, so you might see a large number of indices that follow two patterns:
The security plugin scrubs these index names of special characters, so they might not be a perfect match of tenant names and usernames.
To back up your Kibana data, take a snapshot of all tenant indices using an index pattern such as