Home > docs > plugins v2 > LDAP Task
LDAP Task
The ldap task supports several search queries to an LDAP server.
Possible search operations are:
Usage
To be able to use the ldap task in a Concord flow, it must be added as a
dependency:
configuration:
dependencies:
- mvn://com.walmartlabs.concord.plugins:ldap-task:2.5.0
This adds the task to the classpath and allows you to invoke the LDAP task.
Overview
The ldap task allows users to make search queries to an LDAP server as a step of
a flow. It uses a number of required input parameters that are common for all
operations:
action: determines the operation to be performed with the current invocation of the LDAP taskldapAdServer: URL to the LDAP server, e.gldap://hostname.domain.com:3268
or
dnsSrvRr: DNS service record to identify LDAP server address. Map containing paramsname: Name of the service record, e.g_ldap._tcp.domain.comprotocol: protocol used to establish communication to LDAP serverport: port number on which communication to be established.
bindUserDn: the identifier of the account which is used to bind to the LDAP server for the operationbindPassword: the password of thebindUserDnidentifier, typically provided by usage of the Crypto tasksearchBase: defines the starting point for the search in the directory tree, e.g.DC=subdomain,DC=domain,DC=com
NOTE: Either
ldapAdServerordnsSrvRris mandatory. If both are supplied, preference will be given todnsSrvRr
The ldapAdServer or dnsSrvRr variable configures the
connection to the LDAP server. It is best configured globally by a
default process configuration
policy:
{
"defaultProcessCfg": {
"defaultTaskVariables": {
"ldap": {
"ldapAdServer": "ldap://hostname.domain.com:3268"
}
}
}
}
or
{
"defaultProcessCfg": {
"defaultTaskVariables": {
"ldap": {
"dnsSrvRr": {
"name": "_ldap._tcp.domain.com",
"protocol": "ldaps",
"port": "3269"
}
}
}
}
}
It is best to set bindUserDn and bindPassword with ldapParams argument to provide a default set of parameters to the
task. This is helpful when the task is called multiple times in the flow.
configuration:
arguments:
ldapParams:
bindUserDn: "CN=example,CN=Users,DC=subdomain,DC=domain,DC=com"
bindPassword: "${crypto.exportAsString('bindPassword', 'myStorePassword')}"
A minimal configuration taking advantage of a globally configured API URL
includes the action to perform, the searchBase, and any additional
parameters needed for the action:
flows:
default:
- task: ldap
in:
bindUserDn: "CN=example,CN=Users,DC=subdomain,DC=domain,DC=com"
bindPassword: "${crypto.exportAsString('bindPassword', 'myStorePassword')}"
action: getUser
searchBase: "DC=subdomain,DC=domain,DC=com"
user: "userId"
....
NOTE: The variables set using default process configuration and/or
ldapParamscan be overridden by theinparameters of the task
Search By DN
The LDAP task can be used to search for an LDAP entry by DN (Distinguished Name)
with the searchByDn action.
flows:
default:
- task: ldap
in:
bindUserDn: "CN=example,CN=Users,DC=subdomain,DC=domain,DC=com"
bindPassword: "${crypto.exportAsString('bindPassword', 'myStorePassword')}"
action: searchByDn
searchBase: "DC=subdomain,DC=domain,DC=com"
dn: "CN=exampleCN1,CN=exampleCN2,DC=subdomain,DC=domain,DC=com"
out: searchByDnResult
Additional parameters to use are:
dn: the distinguished name of the LDAP entry
Get User
The LDAP task can be used to search for a user with the getUser action.
flows:
default:
- task: ldap
in:
bindUserDn: "CN=example,CN=Users,DC=subdomain,DC=domain,DC=com"
bindPassword: "${crypto.exportAsString('bindPassword', 'myStorePassword')}"
action: getUser
searchBase: "DC=subdomain,DC=domain,DC=com"
user: ${initiator.username}
out: getUserResult
Additional parameters to use are:
user: the user id, email address, or user principal name to search for
Get Group
The LDAP task can be used to search for a group with the getGroup action. You
can specify whether it is a security group or not by securityEnabled
flows:
default:
- task: ldap
in:
bindUserDn: "CN=example,CN=Users,DC=subdomain,DC=domain,DC=com"
bindPassword: "${crypto.exportAsString('bindPassword', 'myStorePassword')}"
action: getGroup
searchBase: "DC=subdomain,DC=domain,DC=com"
group: "mySecurityGroupName"
securityEnabled: true
out: getGroupResult
Additional parameters to use are:
group: the identifier of the issuesecurityEnabled: a boolean (true/false) that determines whether to search for security group or not
Is Member Of
The LDAP task can be used to check whether a user is a member of a particular
group, includeing recursive searching, with the isMemberOf action.
flows:
default:
- task: ldap
in:
bindUserDn: "CN=example,CN=Users,DC=subdomain,DC=domain,DC=com"
bindPassword: "${crypto.exportAsString('bindPassword', 'myStorePassword')}"
action: isMemberOf
searchBase: "DC=subdomain,DC=domain,DC=com"
user: ${initiator.username}
group: "mySecurityGroupName"
securityEnabled: true
out: isMemberOfResult
user: the user id, email address, or user principal name to search forgroup: the identifier of the issuesecurityEnabled: a boolean (true/false) that determines whether to search for security group or not
