Skip to main content
Version: Next

LDAP

Certified

Important Capabilities​

CapabilityStatusNotes
Detect Deleted Entities✅Enabled by default via stateful ingestion.

This plugin extracts the following:

  • People
  • Names, emails, titles, and manager information for each person
  • List of groups

CLI based Ingestion​

Starter Recipe​

Check out the following recipe to get started with ingestion! See below for full configuration options.

For general pointers on writing and running a recipe, see our main recipe guide.

source:
  type: "ldap"
  config:
    # Coordinates
    ldap_server: ldap://localhost

    # Credentials
    ldap_user: "cn=admin,dc=example,dc=org"
    ldap_password: "admin"

    # Options
    base_dn: "dc=example,dc=org"

sink:
  # sink configs

Config Details​

Note that a . is used to denote nested fields in the YAML recipe.

FieldDescription
base_dn ✅
string
LDAP DN.
ldap_password ✅
string
LDAP password.
ldap_server ✅
string
LDAP server URL.
ldap_user ✅
string
LDAP user.
drop_missing_first_last_name
boolean
If set to true, any users without first and last names will be dropped.
Default: True
filter
string
LDAP extractor filter.
Default: (objectClass=*)
group_attrs_map
object
Default: {}
manager_filter_enabled
boolean
Use LDAP extractor filter to search managers.
Default: True
manager_pagination_enabled
boolean
[deprecated] Use pagination_enabled
Default: True
page_size
integer
Size of each page to fetch when extracting metadata.
Default: 20
pagination_enabled
boolean
Use pagination while do search query (enabled by default).
Default: True
platform_instance
One of string, null
The instance of the platform that all assets produced by this recipe belong to. This should be unique within the platform. See https://docs.datahub.com/docs/platform-instances/ for more details.
Default: None
use_email_as_username
boolean
Use email for users' usernames instead of username (disabled by default). If enabled, the user and group urn would be having email as the id part of the urn.
Default: False
user_attrs_map
object
Default: {}
env
string
The environment that all assets produced by this connector belong to
Default: PROD
attrs_list
One of array, null
Retrieved attributes list
Default: None
attrs_list.string
string
custom_props_list
One of array, null
A list of custom attributes to extract from the LDAP provider.
Default: None
custom_props_list.string
string
stateful_ingestion
One of StatefulStaleMetadataRemovalConfig, null
Default: None
stateful_ingestion.enabled
boolean
Whether or not to enable stateful ingest. Default: True if a pipeline_name is set and either a datahub-rest sink or datahub_api is specified, otherwise False
Default: False
stateful_ingestion.fail_safe_threshold
number
Prevents large amount of soft deletes & the state from committing from accidental changes to the source configuration if the relative change percent in entities compared to the previous state is above the 'fail_safe_threshold'.
Default: 75.0
stateful_ingestion.remove_stale_metadata
boolean
Soft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled.
Default: True

Code Coordinates​

  • Class Name: datahub.ingestion.source.ldap.LDAPSource
  • Browse on GitHub

Questions

If you've got any questions on configuring ingestion for LDAP, feel free to ping us on our Slack.