- Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure: other versions:
- Introducing Elastic Cloud Enterprise
- Preparing your installation
- Installing Elastic Cloud Enterprise
- Identify the deployment scenario
- Install ECE with Ansible
- Install ECE on a public cloud
- Install ECE on your own premises
- Log into the Cloud UI
- Install ECE on additional hosts
- Post-installation steps
- Configuring your installation
- System clusters configuration
- Configure deployment templates
- Tag your allocators
- Edit instance configurations
- Create instance configurations
- Create deployment templates
- Configure system deployment templates
- Configure index management for templates
- Updating custom templates to support
node_roles
and autoscaling - Updating custom templates to support Integrations Server
- Default instance configurations
- Include additional Kibana plugins
- Manage snapshot repositories
- Snapshotting to Google Cloud Storage (GCS) for Elasticsearch 6.4 - 6.8
- Snapshotting to Google Cloud Storage (GCS) for Elasticsearch 7.0 and later
- Snapshotting to Azure Storage for Elasticsearch 5.x and 6.4 - 6.8
- Snapshotting to Azure Storage for Elasticsearch 7.0 and later
- Snapshotting to Minio on-premise storage
- Manage licenses
- Change the ECE API URL
- Change endpoint URLs
- Enable custom endpoint aliases
- Configure allocator affinity
- Securing your installation
- Monitoring your installation
- Administering your installation
- Getting started with deployments
- Create your deployment
- Access Kibana
- Manage data from the command line
- Configure the Java transport client (deprecated)
- Next steps
- Indexing data into Elasticsearch
- Migrating data
- Ingestion methods
- Ingest data with Node.js on Elastic Cloud Enterprise
- Ingest data with Python on Elastic Cloud Enterprise
- Ingest data from Beats to Elastic Cloud Enterprise with Logstash as a proxy
- Ingest data from a relational database into Elastic Cloud Enterprise
- Ingest logs from a Python application using Filebeat
- Ingest logs from a Node.js web application using Filebeat
- Administering deployments
- Change your deployment configuration
- Stop routing requests or pause nodes
- Terminate a deployment
- Restart a deployment
- Restore a deployment
- Delete a deployment
- Migrate to index lifecycle management
- Disable a data tier
- Access the Elasticsearch API console
- Work with snapshots
- Upgrade versions
- Editing your user settings
- Deployment autoscaling
- Configure Beats and Logstash with Cloud ID
- Keep your clusters healthy
- Secure your clusters
- Reset the password for the
elastic
user - Secure your settings
- Secure your 7.x clusters with LDAP
- Secure your 7.x clusters with Active Directory
- Secure your 5.x and 6.x clusters with LDAP
- Secure your 5.x and 6.x clusters with Active Directory
- Secure your clusters with SAML
- Secure your clusters with OpenID Connect
- Secure your clusters with Kerberos
- Reset the password for the
- Trust management
- Deployment heap dumps
- Deployment thread dumps
- Traffic Filtering
- Connect to your cluster
- Manage your Kibana instance
- Manage your APM & Fleet Server (7.13+)
- Manage your APM Server (versions before 7.13)
- Manage your Integrations Server
- Switch from APM to Integrations Server payload
- Enable logging and monitoring
- Enable cross-cluster search and cross-cluster replication
- Enable App Search
- Enable Enterprise Search
- Enable Graph (versions before 5.0)
- Troubleshooting
- RESTful API
- Authentication
- API calls
- How to access the API
- API examples
- Setting up your environment
- A first API call: What deployments are there?
- Create a first Deployment: Elasticsearch and Kibana
- Applying a new plan: Resize and add high availability
- Updating a deployment: Checking on progress
- Applying a new deployment configuration: Upgrade
- Enable more stack features: Add Enterprise Search to a deployment
- Dipping a toe into platform automation: Generate a roles token
- Customize your deployment
- Remove unwanted deployment templates and instance configurations
- Secure your settings
- API reference
- API - Base Url
- APM routes
- Accounts
- App Search - Read-only
- Authentication
- User authentication information
- Disable elevated permissions
- Enable elevated permissions
- Login to ECE
- Logout from ECE
- Refresh authentication token
- Delete API keys
- Get all API keys
- Create API key
- Delete API keys of multiple users
- Get all API keys for all users
- Delete API key
- Get API key
- Available authentication methods
- SAML callback
- Initiate SAML protocol
- Delete API keys for a user
- Get API key metadata for all keys created by the user
- Delete an API key for a user
- Get a user API key
- Billing Costs Analysis
- Get costs overview for the organization. Currently unavailable in self-hosted ECE.
- Get charts for the organization. Currently unavailable in self-hosted ECE.
- Get deployments costs for the organization. Currently unavailable in self-hosted ECE.
- Get charts by deployment. Currently unavailable in self-hosted ECE.
- Get itemized costs by deployments. Currently unavailable in self-hosted ECE.
- Get itemized costs for the organization. Currently unavailable in self-hosted ECE.
- Comments
- Deployment - CRUD
- Deployment - Commands
- Search Deployments
- Migrate Elasticsearch and associated Kibana resources to enable CCR
- Migrate Elasticsearch resource to use ILM
- Migrate Elasticsearch resource to use SLM
- Reset elastic user password
- Restart Deployment Elasticsearch Resource
- Shutdown Deployment Elasticsearch Resource
- Move Elasticsearch resource instances
- Get details about heap dumps for a Deployment
- Start all instances
- Stop all instances
- Start maintenance mode (all instances)
- Stop maintenance mode (all instances)
- Set size overrides
- Start instances
- Stop instances
- Start maintenance mode
- Stop maintenance mode
- Set size overrides
- Capture a new on-demand heap dump for the given instance
- Download the given instance’s heap dump
- Capture a new thread dump for the given instance
- Restart Deployment Stateless Resource
- Shutdown Deployment Stateless Resource
- Upgrade Kibana, APM, Integrations Server, AppSearch, Enterprise Search inside Deployment
- Deployment - Diagnostics
- Deployment - Info
- Deployment - Remote Clusters
- Deployment - Trust
- Deployment - Upgrade Assistant
- Deployment - resync
- Deployment Plan - Activity
- Deployment Resources - CRUD
- Deployment Resources - Proxy
- Deployments - Extensions
- Deployments - Notes
- Deployments - Templates
- Deployments - Traffic Filter - Associations
- Deployments - Traffic Filter - CRUD
- Networking - Deployment Domain Names
- Organizations
- Platform
- Platform - Adminconsoles
- Platform - Allocators
- Get allocators
- Resynchronize allocators
- Search allocators
- Delete allocator
- Get allocator
- Resynchronize allocator
- Move clusters
- Move clusters by type
- Delete allocator logging settings
- Get allocator logging settings
- Update allocator logging settings
- Set allocator logging settings
- Start maintenance mode
- Stop maintenance mode
- Get allocator metadata
- Set allocator metadata
- Delete allocator metadata item
- Set allocator metadata item
- Get allocator settings
- Update allocator settings
- Set allocator settings
- Platform - Configuration - Instances - CRUD
- Platform - Configuration - Security
- Platform - Configuration - Security - Extra Certificates - CRUD
- Platform - Configuration - Security Deployment
- Platform - Configuration - Security Realms
- List security realm configurations
- Reorder security realms
- Create Active Directory configuration
- Delete Active Directory configuration
- Get Active Directory configuration
- Update Active Directory configuration
- Create LDAP configuration
- Delete LDAP configuration
- Get LDAP configuration
- Update LDAP configuration
- Create SAML configuration
- Delete SAML configuration
- Get SAML configuration
- Update SAML configuration
- Platform - Configuration - TLS
- Platform - Configuration - Trust relationships
- Platform - Constructors
- Platform - License
- Platform - Repository - CRUD
- Platform - Runners
- Platform - configuration - Store
- Platform - proxies
- Roles
- Stack - Instance Types - CRUD
- Stack - Versions - CRUD
- Telemetry
- Templates - Deployments - Global
- Users
- Definitions
AbsoluteRefId
AccountResponse
AccountTrustRelationship
AccountTrustSettings
AccountUpdateRequest
ActiveDirectoryGroupSearch
ActiveDirectorySecurityRealmLoadBalance
ActiveDirectorySecurityRealmRoleMappingRule
ActiveDirectorySecurityRealmRoleMappingRules
ActiveDirectorySettings
ActiveDirectoryUserSearch
AdminconsoleInfo
AdminconsolesOverview
AllocatedInstancePlansInfo
AllocatedInstanceStatus
AllocatorBuildInfo
AllocatorCapacity
AllocatorCapacityMemory
AllocatorHealthStatus
AllocatorInfo
AllocatorMoveRequest
AllocatorOverview
AllocatorSettings
AllocatorZoneInfo
AllocatorsSummary
AllocatorsZoneSummary
ApiBaseUrlData
ApiKeyResponse
ApiKeysResponse
Apm
ApmConfiguration
ApmCrudResponse
ApmInfo
ApmPayload
ApmPlan
ApmPlanControlConfiguration
ApmPlanInfo
ApmPlansInfo
ApmResourceInfo
ApmSettings
ApmSubInfo
ApmSystemSettings
ApmTopologyElement
AppSearch
AppSearchConfiguration
AppSearchInfo
AppSearchNodeTypes
AppSearchPayload
AppSearchPlan
AppSearchPlanControlConfiguration
AppSearchPlanInfo
AppSearchPlansInfo
AppSearchResourceInfo
AppSearchSettings
AppSearchSubInfo
AppSearchSystemSettings
AppSearchTopologyElement
AuthenticationInfo
AutodetectStrategyConfig
AvailableAuthenticationMethods
Balance
BasicFailedReply
BasicFailedReplyElement
Blessing
Blessings
BlessingsWithMeta
BoolQuery
CapacityConstraintsResource
CertificateAuthority
CertificateMetaData
ChainStatus
ChangeSourceInfo
ChartItem
ChartItemValue
ChartItems
ClusterCredentials
ClusterCurationSettings
ClusterCurationSpec
ClusterInstanceConfigurationInfo
ClusterInstanceDiskInfo
ClusterInstanceInfo
ClusterInstanceMemoryInfo
ClusterLicenseInfo
ClusterMetadataCpuResourcesSettings
ClusterMetadataInfo
ClusterMetadataPortInfo
ClusterMetadataResourcesSettings
ClusterMetadataSettings
ClusterPlanAttemptError
ClusterPlanStepInfo
ClusterPlanStepLogMessageInfo
ClusterPlanWarning
ClusterSnapshotRepositoryDefault
ClusterSnapshotRepositoryInfo
ClusterSnapshotRepositoryReference
ClusterSnapshotRepositoryStatic
ClusterSnapshotRetention
ClusterSnapshotSettings
ClusterSystemAlert
ClusterTopologyInfo
Comment
CommentCreateRequest
CommentUpdateRequest
CommentWithMeta
CommentsWithMetas
CommonClusterPlanInfo
CompatibleNodeTypesResource
CompatibleVersionResource
ConfigStoreOption
ConfigStoreOptionData
ConfigStoreOptionList
ConstructorHealthStatus
ConstructorInfo
ConstructorOverview
ContainerConfigHostConfig
ContainerSetSummary
ContainerSetsSummary
ContainersEntry
ContainersEntryOptions
ContainersEntryOptionsACL
ContainersEntryOptionsAuth
ContainersEntryOptionsContainerConfig
ContainersEntryOptionsOverrides
CoordinatorSummary
CoordinatorsSummary
Costs
CostsOverview
CreateApiKeyRequest
CreateExtensionRequest
Creates
DeleteApiKeysRequest
DeleteUsersApiKeysRequest
DeploymentCosts
DeploymentCreateMetadata
DeploymentCreateRequest
DeploymentCreateResources
DeploymentCreateResponse
DeploymentCreateSettings
DeploymentDeleteResponse
DeploymentDiagnostics
DeploymentDomainName
DeploymentGetResponse
DeploymentHeapDumps
DeploymentLogging
DeploymentLoggingSettings
DeploymentMetadata
DeploymentMetrics
DeploymentMetricsSettings
DeploymentObservability
DeploymentObservabilitySettings
DeploymentResource
DeploymentResourceCommandResponse
DeploymentResourceCrudResponse
DeploymentResourceUpgradeResponse
DeploymentResources
DeploymentRestoreResponse
DeploymentSearchResponse
DeploymentSettings
DeploymentShutdownResponse
DeploymentTemplateInfoV2
DeploymentTemplateReference
DeploymentTemplateRequestBody
DeploymentUpdateMetadata
DeploymentUpdateRequest
DeploymentUpdateResources
DeploymentUpdateResponse
DeploymentUpdateSettings
DeploymentUpgradeAssistantStatusResponse
DeploymentsCosts
DeploymentsListResponse
DeploymentsListingData
DeploymentsSearchResponse
Dimension
DirectTrustRelationship
DiscreteSizes
DtsDimensionCosts
DtsQuantity
DtsRate
Elasticsearch
ElasticsearchBlockingIssueElement
ElasticsearchBlockingIssues
ElasticsearchClusterBlockingIssueElement
ElasticsearchClusterBlockingIssues
ElasticsearchClusterInfo
ElasticsearchClusterPlan
ElasticsearchClusterPlanInfo
ElasticsearchClusterPlansInfo
ElasticsearchClusterRole
ElasticsearchClusterSecurityInfo
ElasticsearchClusterSettings
ElasticsearchClusterTopologyElement
ElasticsearchClusterTrustSettings
ElasticsearchClusterUser
ElasticsearchConfiguration
ElasticsearchCuration
ElasticsearchDependant
ElasticsearchElasticUserPasswordResetResponse
ElasticsearchInfo
ElasticsearchMasterElement
ElasticsearchMasterInfo
ElasticsearchMonitoringInfo
ElasticsearchNodeType
ElasticsearchPayload
ElasticsearchPlanControlConfiguration
ElasticsearchReplicaElement
ElasticsearchResourceInfo
ElasticsearchScriptTypeSettings
ElasticsearchScriptingUserSettings
ElasticsearchShardElement
ElasticsearchShardsInfo
ElasticsearchShardsStatus
ElasticsearchSystemSettings
ElasticsearchUserBundle
ElasticsearchUserPlugin
ElevatePermissionsRequest
ElevatedPermissions
EmptyResponse
EnableIlmRequest
EnrollmentTokenRequest
EnterpriseSearch
EnterpriseSearchConfiguration
EnterpriseSearchInfo
EnterpriseSearchNodeTypes
EnterpriseSearchPayload
EnterpriseSearchPlan
EnterpriseSearchPlanControlConfiguration
EnterpriseSearchPlanInfo
EnterpriseSearchPlansInfo
EnterpriseSearchResourceInfo
EnterpriseSearchSettings
EnterpriseSearchSubInfo
EnterpriseSearchSystemSettings
EnterpriseSearchTopologyElement
ExistsQuery
Extension
ExtensionFileMetadata
Extensions
ExternalHyperlink
ExternalTrustRelationship
FilterAssociation
GenericResponse
GlobalDeploymentTemplateInfo
GlobalDeploymentTemplateRegion
GrowShrinkStrategyConfig
HeapDump
Hyperlink
IdResponse
IndexPattern
IndexSynchronizationResults
InstanceConfiguration
InstanceConfigurationInfo
InstanceMoveRequest
InstanceOverrides
InstanceTypeResource
IntegrationsServer
IntegrationsServerConfiguration
IntegrationsServerInfo
IntegrationsServerPayload
IntegrationsServerPlan
IntegrationsServerPlanControlConfiguration
IntegrationsServerPlanInfo
IntegrationsServerPlansInfo
IntegrationsServerResourceInfo
IntegrationsServerSettings
IntegrationsServerSystemSettings
IntegrationsServerTopologyElement
ItemCosts
ItemsCosts
KeystoreContents
KeystoreSecret
Kibana
KibanaClusterInfo
KibanaClusterPlan
KibanaClusterPlanInfo
KibanaClusterPlansInfo
KibanaClusterSettings
KibanaClusterTopologyElement
KibanaConfiguration
KibanaDeeplink
KibanaPayload
KibanaPlanControlConfiguration
KibanaResourceInfo
KibanaSubClusterInfo
KibanaSystemSettings
LdapGroupSearch
LdapSecurityRealmLoadBalance
LdapSecurityRealmRoleMappingRule
LdapSecurityRealmRoleMappingRules
LdapSettings
LdapUserSearch
LicenseInfo
LicenseObject
ListEnrollmentTokenElement
ListEnrollmentTokenReply
LoggingSettings
LoginRequest
LoginState
ManagedMonitoringSettings
MatchAllQuery
MatchNoneQuery
MatchQuery
Metadata
MetadataItem
MetadataItemValue
MetadataItems
ModelVersionIndexSynchronizationResults
MoveApmClusterConfiguration
MoveApmClusterDetails
MoveAppSearchConfiguration
MoveAppSearchDetails
MoveClustersCommandResponse
MoveClustersDetails
MoveClustersRequest
MoveElasticsearchClusterConfiguration
MoveElasticsearchClusterDetails
MoveEnterpriseSearchConfiguration
MoveEnterpriseSearchDetails
MoveKibanaClusterConfiguration
MoveKibanaClusterDetails
NestedQuery
NodeTypeResource
Note
Notes
ObservabilityIssue
Organization
OrganizationInvitation
OrganizationInvitationRequest
OrganizationInvitations
OrganizationList
OrganizationMembership
OrganizationMemberships
OrganizationRequest
Orphaned
OrphanedElasticsearch
PendingState
PendingStates
PendingStatesWithMeta
Period
PlanStrategy
PlatformInfo
PlatformResourcesSummary
PlatformServiceImageInfo
PlatformServiceInfo
PortBinding
PrefixQuery
ProxiesAllocationsInfo
ProxiesFilter
ProxiesFilteredGroup
ProxiesFilteredGroupHealth
ProxiesHealth
ProxiesHttpSettings
ProxiesSSOSettings
ProxiesSettings
ProxiesSummary
ProxyAllocationCounts
ProxyAllocationInfo
ProxyInfo
ProxyOverview
ProxySummary
PublicCertChain
PublicCertChainCollection
PublicCertificate
QueryContainer
QueryStringQuery
RangeQuery
ReadOnlyRequest
ReadOnlyResponse
RegionInfo
RemoteResourceInfo
RemoteResourceRef
RemoteResources
ReplyWarning
RepositoryConfig
RepositoryConfigs
RequestEnrollmentTokenReply
ResourceHeapDumps
RestartPolicy
RestoreSnapshotApiConfiguration
RestoreSnapshotConfiguration
RestoreSnapshotRepoConfiguration
Role
RoleAggregate
RoleAggregateCreateData
RoleAggregates
RoleWithMeta
RollingGrowShrinkStrategyConfig
RollingStrategyConfig
RulesetAssociations
RunnerBuildInfo
RunnerContainerInfo
RunnerInfo
RunnerOverview
RunnerRoleInfo
RunnerRolesInfo
RunnersSummary
SamlAttributeSettings
SamlIdpSettings
SamlSecurityRealmRoleMappingRule
SamlSecurityRealmRoleMappingRules
SamlSettings
SamlSpSettings
SearchRequest
SecurityDeployment
SecurityDeploymentCreateRequest
SecurityDeploymentTopology
SecurityDeploymentUpdateRequest
SecurityRealmInfo
SecurityRealmInfoList
SecurityRealmsReorderRequest
ServiceUrl
SimplifiedLineItem
SnapshotRepositoryConfiguration
SnapshotStatusInfo
SsoAuthenticationMethodInfo
StackVersionApmConfig
StackVersionAppSearchConfig
StackVersionArchiveProcessingError
StackVersionArchiveProcessingResult
StackVersionConfig
StackVersionConfigPost
StackVersionConfigs
StackVersionElasticsearchConfig
StackVersionEnterpriseSearchConfig
StackVersionInstanceCapacityConstraint
StackVersionIntegrationsServerConfig
StackVersionKibanaConfig
StackVersionMetadata
StackVersionNodeType
StackVersionTemplateFileHash
StackVersionTemplateInfo
TargetElasticsearchCluster
TelemetryConfig
TelemetryConfigRequest
TermQuery
TlsPublicCertChain
TokenResponse
TopologyElementControl
TopologySize
TrafficFilterEgressRule
TrafficFilterRule
TrafficFilterRulesetInfo
TrafficFilterRulesetRequest
TrafficFilterRulesetResponse
TrafficFilterRulesets
TrafficFilterSettings
TransientApmPlanConfiguration
TransientAppSearchPlanConfiguration
TransientElasticsearchPlanConfiguration
TransientEnterpriseSearchPlanConfiguration
TransientIntegrationsServerPlanConfiguration
TransientKibanaPlanConfiguration
TrustRelationshipCreateRequest
TrustRelationshipCreateResponse
TrustRelationshipGetResponse
TrustRelationshipUpdateRequest
TrustRelationshipUpdateResponse
TrustRelationshipsListResponse
TrustedCertificate
UnreachableRegionInfo
UpdateExtensionRequest
UpdatedTlsChain
Updates
UsageStats
User
UserApiKey
UserList
UserMetadata
UserSecurity
UserSecurityRealm
ZookeeperNodeInfo
ZookeeperSummary
- Changes to index allocation and API
- Script reference
- Glossary
- Release notes
- Elastic Cloud Enterprise 3.2.1
- Elastic Cloud Enterprise 3.2.0
- Elastic Cloud Enterprise 3.1.1
- Elastic Cloud Enterprise 3.1.0
- Elastic Cloud Enterprise 3.0.0
- Elastic Cloud Enterprise 2.13.4
- Elastic Cloud Enterprise 2.13.3
- Elastic Cloud Enterprise 2.13.2
- Elastic Cloud Enterprise 2.13.1
- Elastic Cloud Enterprise 2.13.0
- Elastic Cloud Enterprise 2.12.4
- Elastic Cloud Enterprise 2.12.3
- Elastic Cloud Enterprise 2.12.2
- Elastic Cloud Enterprise 2.12.1
- Elastic Cloud Enterprise 2.12.0
- Elastic Cloud Enterprise 2.11.2
- Elastic Cloud Enterprise 2.11.1
- Elastic Cloud Enterprise 2.11.0
- Elastic Cloud Enterprise 2.10.1
- Elastic Cloud Enterprise 2.10.0
- Elastic Cloud Enterprise 2.9.2
- Elastic Cloud Enterprise 2.9.1
- Elastic Cloud Enterprise 2.9.0
- Elastic Cloud Enterprise 2.8.1
- Elastic Cloud Enterprise 2.8.0
- Elastic Cloud Enterprise 2.7.2
- Elastic Cloud Enterprise 2.7.1
- Elastic Cloud Enterprise 2.7.0
- Elastic Cloud Enterprise 2.6.2
- Elastic Cloud Enterprise 2.6.1
- Elastic Cloud Enterprise 2.6.0
- Elastic Cloud Enterprise 2.5.1
- Elastic Cloud Enterprise 2.5.0
- Elastic Cloud Enterprise 2.4.3
- Elastic Cloud Enterprise 2.4.2
- Elastic Cloud Enterprise 2.4.1
- Elastic Cloud Enterprise 2.4.0
- Elastic Cloud Enterprise 2.3.2
- Elastic Cloud Enterprise 2.3.1
- Elastic Cloud Enterprise 2.3.0
- Elastic Cloud Enterprise 2.2.3
- Elastic Cloud Enterprise 2.2.2
- Elastic Cloud Enterprise 2.2.1
- Elastic Cloud Enterprise 2.2.0
- Elastic Cloud Enterprise 2.1.1
- Elastic Cloud Enterprise 2.1.0
- Elastic Cloud Enterprise 2.0.1
- Elastic Cloud Enterprise 2.0.0
- Elastic Cloud Enterprise 1.1.5
- Elastic Cloud Enterprise 1.1.4
- Elastic Cloud Enterprise 1.1.3
- Elastic Cloud Enterprise 1.1.2
- Elastic Cloud Enterprise 1.1.1
- Elastic Cloud Enterprise 1.1.0
- Elastic Cloud Enterprise 1.0.2
- Elastic Cloud Enterprise 1.0.1
- Elastic Cloud Enterprise 1.0.0
- What’s new with the Elastic Stack
- About this product
Secure your 5.x and 6.x clusters with Active Directory
editSecure your 5.x and 6.x clusters with Active Directory
editThese steps show how you can secure your 5.x and 6.x Elasticsearch clusters and Kibana instances with the Lightweight Directory Access Protocol(LDAP) using an Active Directory.
For version 7.x, check Secure your 7.x clusters with Active Directory.
Before you begin
editTo learn more about how securing Elasticsearch clusters with Active Directory works, check Active Directory user authentication.
The AD credentials are valid against the deployment, not the ECE platform. You can configure role-based access control for the platform separately.
Configure authentication with Active Directory
editYou can configure the deployment to authenticate users by communicating with an Active Directory Domain Controller. To integrate with AD,
you need to configure an active_directory
realm and map AD groups to user roles in Elasticsearch.
-
Contrary to the
ldap
realm, theactive_directory
realm only supports a user search mode but you can select to use a bind user or not.The Active Directory realm authenticates users using an LDAP bind request. By default, and assuming you don’t specify a
bind_dn
, all of the LDAP operations are run by the user that is currently authenticating.When you specify a
bind_dn
, this specific user is used to search for the DN of the authenticating user based on the provided username and an LDAP attribute. Once found, the user is authenticated by attempting to bind to the LDAP server using the found DN and the provided password. -
To configure an active directory realm, add your user settings for the
active_directory
realm as follows:xpack: security: authc: realms: my_ad: type: active_directory order: 2 domain_name: ad.example.com url: ldap://ad.example.com:389
The type of the realm, should be
active_directory
.The order in which the active_directory realm will be consulted during an authentication attempt.
The primary domain in AD. Note that binding to Active Directory fails if the domain name is not mapped in DNS.
The LDAP URL pointing to the AD Domain Controller that should handle authentication. If your Domain Controller is configured to use LDAP over TLS and it uses a self-signed certificate or a certificate that is signed by your organization’s CA, refer to the following configuration instructions.
You must apply the user settings to each deployment template.
-
Alternatively, to configure an active directory realm using a bind user, add your user settings for the
active_directory
realm as follows:xpack: security: authc: realms: my_ad: type: active_directory order: 2 domain_name: ad.example.com url: ldap://ad.example.com:389 bind_dn: es_svc_user@ad.example.com
The type of the realm, should be
active_directory
.The order in which the active_directory realm will be consulted during an authentication attempt.
The primary domain in AD. Note that binding to Active Directory fails if the domain name is not mapped in DNS.
The LDAP URL pointing to the AD Domain Controller that should handle authentication. If your Domain Controller is configured to use LDAP over TLS and it uses a self-signed certificate or a certificate that is signed by your organization’s CA, refer to the following configuration instructions.
This is the user that all Active Directory search requests are executed as.
-
In versions before 6.3, you can configure a password for the
bind_dn
user by addingbind_password: the_password
to the preceding user settings example. -
From version 6.3, you can configure the password for the
bind_dn
user by adding the appropriatesecure_bind_password
setting to the Elasticsearch keystore.-
From the Deployments page, select your deployment.
Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.
- From your deployment menu, select Security.
- Under the Elasticsearch keystore section, select Add settings.
-
On the Create setting window, select the secret Type to be
Secret String
. -
Set the Setting name` to
xpack.security.authc.realms.my_ad.secure_bind_password
and add the password for thebind_dn
user in thesecret
field.After you configure
secure_bind_password
, any attempt to restart the deployment will fail until you complete the rest of the configuration steps. If you wish to rollback the Active Directory realm related configuration effort, you need to remove thexpack.security.authc.realms.my_ad.secure_bind_password
that was just added by using the "remove" button by the setting name underExisting Keystores
.
-
-
(Optional) Encrypt communications between the deployment and the Domain Controller. If your LDAP server uses a self-signed certificate or a certificate that is signed by your organization’s CA, you need to enable the deployment to trust this certificate.
-
Prepare a custom bundle as a ZIP file that contains the CA certificate file (for example
ca.crt
) inside of acacerts
folder` in the same way that you would on Elastic Cloud. -
Update your plan in the advanced configuration editor so that it uses the bundle you prepared in the previous step. You need to modify the
user_bundles
JSON attribute similar to the following example:{ "cluster_name": "REPLACE_WITH_YOUR_CLUSTER_NAME", "plan": { ... "elasticsearch": { "version": "6.*", "user_bundles": [ { "name": "ldap-cert", "url": "https://www.myurl.com/adcert.zip", "elasticsearch_version": "6.*" } ] } }
You must specify the
user_bundles
attribute for each deployment template.The URL that point to
adcert.zip
must be accessible to the cluster. Also, when you*
a minor versions bundles are compatible with any Elasticsearch major version to avoid a need to re-upload a new bundle with minor versions upgrade. In this example the bundle is compatible with any Elasticsearch 6.* version. -
Custom bundles get unzipped under the path
/app/config/BUNDLE_DIRECTORY_STRUCTURE
, whereBUNDLE_DIRECTORY_STRUCTURE
is the directory structure within the bundle ZIP file itself. For example:$ tree . . └── cacerts └── ca.crt
So in our example, the unzipped keystore file gets placed under
/app/config/cacerts/ca.crt
-
Update your user settings for the
active_directory
realm as followsxpack: security: authc: realms: my_ad: type: active_directory order: 2 domain_name: ad.example.com url: ldaps://ad.example.com:636 bind_dn: es_svc_user@ad.example.com ssl: certificate_authorities: ["/app/config/cacerts/ca.crt"] verification_mode: certificate
The type of the realm, should be
active_directory
.The
ldaps
URL pointing to the AD Domain Controller.(Optional) By default, when you configure Elasticsearch to connect to an Domain Controller using SSL/TLS, it attempts to verify the hostname or IP address specified with the url attribute in the realm configuration with the values in the certificate. If the values in the certificate and realm configuration do not match, Elasticsearch does not allow a connection to the Domain Controller. This is done to protect against man-in-the-middle attacks. If necessary, you can disable this behavior by setting the
ssl.verification_mode
property tocertificate
.
-
Prepare a custom bundle as a ZIP file that contains the CA certificate file (for example
If your CA certificate is available as a JKS
or PKCS#12
keystore, you can upload that file in the ZIP bundle ( for example
create a ZIP archive from a truststore
folder that contains a file named ca.p12
) and then reference it in the user settings with
xpack.security.authc.realms.my_ad.ssl.truststore.path: "/app/config/truststore/ca.p12"
. If the keystore is also password protected (
which is unusual for keystores that contain only CA certificates ), you can also provide the password for the keystore by adding
xpack.security.authc.realms.my_ad.ssl.truststore.password: password
in the user settings.
Mapping Active Directory groups to roles
editYou have two ways of mapping Active Directory groups to roles for your users. The preferred one is to use the role mapping API. If for some reason this is not possible, you can use a role mapping file to specify the mappings instead.
Only Active Directory security groups are supported. You cannot map distribution groups to roles.
Using the Role Mapping API
editLet’s assume that you want all your users that authenticate through AD to have read-only access to a certain index my-index
and the AD
users that are members of the cn=administrators, dc=example, dc=com
group in LDAP, to become superusers in your deployment:
-
Create the read-only role
-
Create the relevant role mapping rule for read only users
-
Create the relevant role mapping rule for superusers
Using the Role Mapping files
editLet’s assume that you want all your users that authenticate through AD and are members of the cn=my-users,dc=example, dc=com
group in
AD to have read-only access to a certain index my-index
and only the users
cn=Senior Manager, cn=management, dc=example, dc=com
and
cn=Senior Admin, cn=management, dc=example, dc=com
to become superusers in your deployment:
-
Create a file name named
role-mappings.yml
with the following contentssuperuser: - cn=Senior Manager, cn=management, dc=example, dc=com - cn=Senior Admin, cn=management, dc=example, dc=com read-only-user: - cn=my-users, dc=example, dc=com
-
Prepare a custom bundle as a ZIP file that contains the role-mappings.yml file inside of a
mappings
folder` in the same way that you would on Elastic Cloud. -
Update your plan in the advanced configuration editor so that it uses the bundle you prepared in the previous step. You need to modify the
user_bundles
JSON attribute similar to the following example:{ "cluster_name": "REPLACE_WITH_YOUR_CLUSTER_NAME", "plan": { ... "elasticsearch": { "version": "6.*", "user_bundles": [ { "name": "role-mappings", "url": "https://www.myurl.com/mappings.zip", "elasticsearch_version": "6.*" } ] } }
The URL that point to
mappings.zip
must be accessible to the cluster. Also, when you*
a minor versions bundles are compatible with any Elasticsearch major version to avoid a need to re-upload a new bundle with minor versions upgrade. In this example the bundle is compatible with any Elasticsearch 6.* version.-
Custom bundles get unzipped under the path
/app/config/BUNDLE_DIRECTORY_STRUCTURE
, whereBUNDLE_DIRECTORY_STRUCTURE
is the directory structure within the bundle ZIP file itself. For example:$ tree . . └── mappings └── role-mappings.yml
So in our example, the unzipped role mappings file gets placed under
/app/config/mappings/role-mappings.yml
-
Update your user settings for the
ldap
realm as follows (building from previous examples)xpack: security: authc: realms: my_ad: type: active_directory order: 2 domain_name: ad.example.com url: ldaps://ad.example.com:636 bind_dn: es_svc_user@ad.example.com ssl: certificate_authorities: ["/app/config/cacerts/ca.crt"] verification_mode: certificate files: role_mapping: "/app/config/mappings/role-mappings.yml"
-
On this page