Active Directory Entity Analytics
<div class="condensed-table">
| | |
| --- | --- |
| Version | 0.6.0 [beta] (View all) |
| Compatible Kibana version(s) | 8.16.0 or higher |
| Supported Serverless project types
What’s this? | Security
Observability |
| Subscription level
What’s this? | Basic |
| Level of support
What’s this? | Elastic |
</div>
This Active Directory Entity Analytics integration allows users to securely stream User Entities data to Elastic Security via the Active Directory LDAP look-ups. When integrated with Elastic Security, this valuable data can be leveraged within Elastic for risk-scoring scenarios (e.g., context enrichments) and detecting advanced analytics (UBA) use cases.
The Active Directory Entity Analytics integration collects one type of data: user.
- User is used to retrieve all user entries available from an Active Directory server.
Elastic Agent must be installed. For more details and installation instructions, please refer to the Elastic Agent Installation Guide.
There are several options for installing and managing Elastic Agent:
With this approach, you install Elastic Agent and use Fleet in Kibana to define, configure, and manage your agents in a central location. We recommend using Fleet management because it makes the management and upgrade of your agents considerably easier.
With this approach, you install Elastic Agent and manually configure the agent locally on the system where it’s installed. You are responsible for managing and upgrading the agents. This approach is reserved for advanced users only.
You can run Elastic Agent inside a container, either with Fleet Server or standalone. Docker images for all versions of Elastic Agent are available from the Elastic Docker registry, and we provide deployment manifests for running on Kubernetes.
Please note, there are minimum requirements for running Elastic Agent. For more information, refer to the Elastic Agent Minimum Requirements.
- Obtain the LDAP username, e.g.
CN=Administrator,CN=Users,DC=testserver,DC=local
and password, and LDAP host address for the Active Directory server that you will be collecting data from. - Determine the Base DN for the directory to be used, e.g.
CN=Users,DC=testserver,DC=local
.
- In Kibana, navigate to Management > Integrations.
- In the "Search for integrations" top bar, search for
Active Directory Entity Analytics
. - Select the "Active Directory Entity Analytics" integration from the search results.
- Select "Add Active Directory Entity Analytics Integration" to add the integration.
- While adding the integration, add the user, host and base DN details obtained above.
- Save the integration by adding other necessary parameters.
The Active Directory provider periodically contacts the server, retrieving updates for users, updates its internal cache of user metadata, and ships updated user metadata to Elasticsearch.
Fetching and shipping updates occurs in one of two processes: full synchronizations and incremental updates. Full synchronizations will send the entire list of users in state, along with write markers to indicate the start and end of the synchronization event. Incremental updates will only send data for changed users during that event. Changes on a user can come in many forms, whether it be a change to the user’s metadata, or a user was added or deleted. By default, full synchronizations occur every 24 hours and incremental updates occur every 15 minutes. These intervals may be customized to suit your use case.
This is the User
dataset.
**Example**
An example event for user
looks as following:
{
"@timestamp": "2024-04-02T02:44:08.198Z",
"agent": {
"ephemeral_id": "c8f2cffa-8316-41a2-8ad6-89ef2f3ecd2b",
"id": "277a9e26-8aae-4bc6-abcc-21db22ad29d7",
"name": "docker-fleet-agent",
"type": "filebeat",
"version": "8.13.0"
},
"asset": {
"category": "entity",
"type": "activedirectory_user"
},
"data_stream": {
"dataset": "entityanalytics_ad.user",
"namespace": "ep",
"type": "logs"
},
"ecs": {
"version": "8.11.0"
},
"elastic_agent": {
"id": "277a9e26-8aae-4bc6-abcc-21db22ad29d7",
"snapshot": false,
"version": "8.13.0"
},
"event": {
"action": "started",
"agent_id_status": "verified",
"category": [
"iam"
],
"dataset": "entityanalytics_ad.user",
"ingested": "2024-04-02T02:44:20Z",
"kind": "asset",
"start": "2024-04-02T02:44:08.198Z",
"type": [
"info"
]
},
"input": {
"type": "entity-analytics"
},
"labels": {
"identity_source": "entity-analytics-entityanalytics_ad.user-2270bd23-5392-4185-959b-b01ac2b8d89a"
},
"tags": [
"users-entities",
"preserve_duplicate_custom_fields",
"forwarded",
"entityanalytics_ad-user"
]
}
**Exported fields**
Field | Description | Type |
---|---|---|
@timestamp | Event timestamp. | date |
asset.category | keyword | |
asset.costCenter | keyword | |
asset.create_date | date | |
asset.id | keyword | |
asset.last_seen | date | |
asset.last_status_change_date | date | |
asset.last_updated | date | |
asset.name | keyword | |
asset.status | keyword | |
asset.type | keyword | |
asset.vendor | keyword | |
data_stream.dataset | Data stream dataset. | constant_keyword |
data_stream.namespace | Data stream namespace. | constant_keyword |
data_stream.type | Data stream type. | constant_keyword |
entityanalytics_ad.groups.admin_count | keyword | |
entityanalytics_ad.groups.cn | keyword | |
entityanalytics_ad.groups.description | keyword | |
entityanalytics_ad.groups.distinguished_name | keyword | |
entityanalytics_ad.groups.ds_core_propagation_data | date | |
entityanalytics_ad.groups.group_type | keyword | |
entityanalytics_ad.groups.instance_type | keyword | |
entityanalytics_ad.groups.is_critical_system_object | boolean | |
entityanalytics_ad.groups.member | keyword | |
entityanalytics_ad.groups.member_of | keyword | |
entityanalytics_ad.groups.name | keyword | |
entityanalytics_ad.groups.object_category | keyword | |
entityanalytics_ad.groups.object_class | keyword | |
entityanalytics_ad.groups.object_guid | keyword | |
entityanalytics_ad.groups.object_sid | keyword | |
entityanalytics_ad.groups.sam_account_name | keyword | |
entityanalytics_ad.groups.sam_account_type | keyword | |
entityanalytics_ad.groups.usn_changed | keyword | |
entityanalytics_ad.groups.usn_created | keyword | |
entityanalytics_ad.groups.when_changed | date | |
entityanalytics_ad.groups.when_created | date | |
entityanalytics_ad.id | keyword | |
entityanalytics_ad.user.account_expires | keyword | |
entityanalytics_ad.user.admin_count | keyword | |
entityanalytics_ad.user.bad_password_time | keyword | |
entityanalytics_ad.user.bad_pwd_count | keyword | |
entityanalytics_ad.user.cn | keyword | |
entityanalytics_ad.user.code_page | keyword | |
entityanalytics_ad.user.country_code | keyword | |
entityanalytics_ad.user.description | keyword | |
entityanalytics_ad.user.distinguished_name | keyword | |
entityanalytics_ad.user.ds_core_propagation_data | date | |
entityanalytics_ad.user.instance_type | keyword | |
entityanalytics_ad.user.is_critical_system_object | boolean | |
entityanalytics_ad.user.last_logoff | keyword | |
entityanalytics_ad.user.last_logon | date | |
entityanalytics_ad.user.last_logon_timestamp | date | |
entityanalytics_ad.user.logon_count | keyword | |
entityanalytics_ad.user.member_of | keyword | |
entityanalytics_ad.user.msds-supported_encryption_types | keyword | |
entityanalytics_ad.user.name | keyword | |
entityanalytics_ad.user.object_category | keyword | |
entityanalytics_ad.user.object_class | keyword | |
entityanalytics_ad.user.object_guid | keyword | |
entityanalytics_ad.user.object_sid | keyword | |
entityanalytics_ad.user.primary_group_id | keyword | |
entityanalytics_ad.user.pwd_last_set | date | |
entityanalytics_ad.user.sam_account_name | keyword | |
entityanalytics_ad.user.sam_account_type | keyword | |
entityanalytics_ad.user.service_principal_name | keyword | |
entityanalytics_ad.user.show_in_advanced_view_only | boolean | |
entityanalytics_ad.user.user_account_control | keyword | |
entityanalytics_ad.user.usn_changed | keyword | |
entityanalytics_ad.user.usn_created | keyword | |
entityanalytics_ad.user.when_changed | date | |
entityanalytics_ad.user.when_created | date | |
entityanalytics_ad.when_changed | date | |
event.dataset | Event dataset. | constant_keyword |
event.module | Event module. | constant_keyword |
input.type | Type of filebeat input. | keyword |
labels.identity_source | keyword | |
user.account.activated_date | date | |
user.account.change_date | date | |
user.account.create_date | date | |
user.account.password_change_date | date | |
user.account.status.deprovisioned | boolean | |
user.account.status.locked_out | boolean | |
user.account.status.password_expired | boolean | |
user.account.status.recovery | boolean | |
user.account.status.suspended | boolean | |
user.geo.city_name | keyword | |
user.geo.country_iso_code | keyword | |
user.geo.name | keyword | |
user.geo.postal_code | keyword | |
user.geo.region_name | keyword | |
user.geo.timezone | keyword | |
user.organization.name | keyword | |
user.profile.department | keyword | |
user.profile.first_name | keyword | |
user.profile.id | keyword | |
user.profile.job_title | keyword | |
user.profile.last_name | keyword | |
user.profile.manager | keyword | |
user.profile.mobile_phone | keyword | |
user.profile.other_identities | keyword | |
user.profile.primaryPhone | keyword | |
user.profile.secondEmail | keyword | |
user.profile.status | keyword | |
user.profile.type | keyword |
**Changelog**
Version | Details | Kibana version(s) |
---|---|---|
0.6.0 | pass:[] Enhancement (View pull request) Add "preserve_original_event" tag to documents with event.kind manually set to "pipeline_error". |
— |
0.5.0 | pass:[] Enhancement (View pull request) Add "preserve_original_event" tag to documents with event.kind set to "pipeline_error". |
— |
0.4.0 | pass:[] Enhancement (View pull request) Expose user and group attribute configurations to the user. |
— |
0.3.2 | pass:[] Bug fix (View pull request) Don’t leak collection implementation details. |
— |
0.3.1 | pass:[] Enhancement (View pull request) Update documentation. |
— |
0.3.0 | pass:[] Enhancement (View pull request) Format SID and GUID in canonical formats. |
— |
0.2.0 | pass:[] Enhancement (View pull request) Expose paging size configuration to the user. |
— |
0.1.0 | pass:[] Enhancement (View pull request) Removed import_mappings. Modified the field definitions to remove ECS fields made redundant by the ecs@mappings component template. |
— |
0.0.1 | pass:[] Enhancement (View pull request) Initial Release. |
— |