Search

type: "io.kestra.plugin.ldap.Search"

Retrieves entries in LDAP.

Search and list entries based on a filter list for each base DN target.

Examples

Retrieve LDAP entries. In this example, assuming that their is exactly one entry matching each of our filter, the outputs of the task would be four entries in this order (since we search two times in the same baseDn) : (dn, description, mail) of {melusine, metatron, melusine, metatron}.

id: ldap_search
namespace: company.team

tasks:
  - id: search
    type: io.kestra.plugin.ldap.Search
    userDn: cn=admin,dc=orga,dc=en
    password: admin
    baseDn: ou=people,dc=orga,dc=en
    filter: (|(sn=melusine*)(sn=metatron*))
    attributes:
      - description
      - mail
    hostname: 0.0.0.0
    port: 15060

Properties

hostname

• Type: string
• Dynamic: ✔️
• Required: ✔️

Hostname

Hostname for connection.

password

• Type: string
• Dynamic: ✔️
• Required: ✔️

Password

User password for connection.

port

• Type: string
• Dynamic: ✔️
• Required: ✔️

Port

A whole number describing the port for connection.

userDn

• Type: string
• Dynamic: ✔️
• Required: ✔️

User DN

User DN for connection.

attributes

• Type: array
• SubType: string
• Dynamic: ✔️
• Required: ❌
• Default: [*]

Attributes

Specific attributes to retrieve from the filtered entries. Retrieves all attributes by default. Sepcial attributes may be specified : "+" -> OPERATIONAL_ATTRIBUTES "1.1" -> NO_ATTRIBUTES "0.0" -> ALL_ATTRIBUTES_EXCEPT_OPERATIONAL `--> This special attribute canno't be combined with other attributes and the search will ignore everything else.

baseDn

• Type: string
• Dynamic: ✔️
• Required: ❌
• Default: ou=system

Base DN

Base DN target in the LDAP.

filter

• Type: string
• Dynamic: ✔️
• Required: ❌
• Default: (objectclass=*)

Filter

Filter for the search in the LDAP.

sub

• Type: SearchScope
• Dynamic: ✔️
• Required: ❌
• Default: {name=SUB}

SUB

Search scope of the filter : BASE -- Indicates that only the entry specified by the base DN should be considered. ONE -- Indicates that only entries that are immediate subordinates of the entry specified by the base DN (but not the base entry itself) should be considered. SUB -- Indicates that the base entry itself and any subordinate entries (to any depth) should be considered. SUBORDINATE_SUBTREE -- Indicates that any subordinate entries (to any depth) below the entry specified by the base DN should be considered, but the base entry itself should not be considered, as described in draft-sermersheim-ldap-subordinate-scope.

Outputs

uri

• Type: string
• Required: ❌
• Format: uri

Result file URI

A file that contains zero or more matching queries as LDIF formatted strings.

Definitions

com.unboundid.ldap.sdk.SearchScope

Properties

name

• Type: string
• Dynamic: ❓
• Required: ❌