Skip to main content

LDAP

Module ldap

Certified

This plugin extracts the following:

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

CLI based Ingestion

Install the Plugin

pip install 'acryl-datahub[ldap]'

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.

View All Configuration Options
Field [Required]TypeDescriptionDefaultNotes
attrs_list [✅]array(string)None
base_dn [✅]stringLDAP DN.None
custom_props_list [✅]array(string)None
drop_missing_first_last_name [✅]booleanIf set to true, any users without first and last names will be dropped.True
filter [✅]stringLDAP extractor filter.(objectClass=*)
group_attrs_map [✅]objectNone
ldap_password [✅]stringLDAP password.None
ldap_server [✅]stringLDAP server URL.None
ldap_user [✅]stringLDAP user.None
page_size [✅]integerSize of each page to fetch when extracting metadata.20
platform_instance [✅]stringThe instance of the platform that all assets produced by this recipe belong toNone
user_attrs_map [✅]objectNone
env [✅]stringThe environment that all assets produced by this connector belong toPROD
stateful_ingestion [✅]StatefulStaleMetadataRemovalConfigBase specialized config for Stateful Ingestion with stale metadata removal capability.None
stateful_ingestion.enabled [❓ (required if stateful_ingestion is set)]booleanThe type of the ingestion state provider registered with datahub.None
stateful_ingestion.ignore_new_state [❓ (required if stateful_ingestion is set)]booleanIf set to True, ignores the current checkpoint state.None
stateful_ingestion.ignore_old_state [❓ (required if stateful_ingestion is set)]booleanIf set to True, ignores the previous checkpoint state.None
stateful_ingestion.remove_stale_metadata [❓ (required if stateful_ingestion is set)]booleanSoft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled.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