SOAP API - getLdapEntry

Request

Uses the getLdapEntryelement (from the DirectoryService schema)

Parameter notes

ldap-alias: the alias of the LDAP entry being enquired upon. LDAP connection shared resources are named with the prefix ldap/de/ in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the ldap/de/ prefix. Can be obtained from a previous call to listLdapConnections .
ldap-dn: the base Distinguished Name (DN) to which the query is restricted. This is relative to, and in addition to, any base DN specified in the LDAP connection shared resource's URL. You can get the required ldap-dn from a previous call to one of the listCandidateResources , executeLdapQuery , or getResource operations.
attribute name: the name of the attribute being enquired about. There may be zero or more repetitions of this entry, one per attribute. If no attribute names are included, all the entry’s attributes are returned.

Response

Returns a getLdapEntryResponseelement (from the DirectoryService schema).

If the identified LDAP entry does not exist or cannot be identified, the response includes:
```
not-found="true"
```

If the attribute name that you enter matches more than one attribute, all matches will be returned. For example, entering <attribute name="name"/ may return:

<attribute name="ou" xmlns=""> <value>Clint Hill</value> </attribute> <attribute name="givenname" xmlns=""> <value>Clint</value> </attribute> <attribute name="sn" xmlns=""> <value>Hill</value> </attribute> <attribute name="cn" xmlns=""> <value>Mr Clint Hill</value> </attribute>

Example

Request:

<soapenv:Body>
      <dir:getLdapEntry ldap-alias="easyAs" ldap-dn="OU=Clint Hill, OU=Swindon, OU=AllEmployees, O=easyAsInsurance" name="Clint Hill">
         <attribute name="employeetype"/>
         <attribute name="manager"/>
</dir:getLdapEntry>
</soapenv:Body>

Response:

<SOAP-ENV:Body>
      <getLdapEntryResponse ldap-alias="easyAs" ldap-dn="OU=Clint Hill, OU=Swindon, OU=AllEmployees, O=easyAsInsurance" xmlns="http://directory.api.de.bpm.tibco.com">
         <attribute name="employeetype" xmlns="">
            <value>Permanent</value>
         </attribute>
         <attribute name="manager" xmlns="">
            <value>ou=John Eustace,ou=Swindon,ou=AllEmployees,o=easyAsInsurance</value>
         </attribute>
      </getLdapEntryResponse>
</SOAP-ENV:Body>

Request	Uses the getLdapEntryelement (from the DirectoryService schema)
Parameter notes	ldap-alias: the alias of the LDAP entry being enquired upon. LDAP connection shared resources are named with the prefix ldap/de/ in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the ldap/de/ prefix. Can be obtained from a previous call to listLdapConnections . ldap-dn: the base Distinguished Name (DN) to which the query is restricted. This is relative to, and in addition to, any base DN specified in the LDAP connection shared resource's URL. You can get the required ldap-dn from a previous call to one of the listCandidateResources , executeLdapQuery , or getResource operations. attribute name: the name of the attribute being enquired about. There may be zero or more repetitions of this entry, one per attribute. If no attribute names are included, all the entry’s attributes are returned.
Response	Returns a getLdapEntryResponseelement (from the DirectoryService schema). If the identified LDAP entry does not exist or cannot be identified, the response includes: not-found=`"true"` If the attribute name that you enter matches more than one attribute, all matches will be returned. For example, entering <attribute name="name"/ may return: <attribute name="`ou`" xmlns=""> <value>`Clint Hill`</value> </attribute> <attribute name="`givenname`" xmlns=""> <value>`Clint`</value> </attribute> <attribute name="`sn`" xmlns=""> <value>`Hill`</value> </attribute> <attribute name="`cn`" xmlns=""> <value>`Mr Clint Hill`</value> </attribute>
Example	Request: <soapenv:Body> <dir:getLdapEntry ldap-alias="`easyAs`" ldap-dn="`OU=Clint Hill, OU=Swindon, OU=AllEmployees, O=easyAsInsurance`" name="`Clint Hill`"> <attribute name="`employeetype`"/> <attribute name="`manager`"/> </dir:getLdapEntry> </soapenv:Body>
Example	Response: <SOAP-ENV:Body> <getLdapEntryResponse ldap-alias="`easyAs`" ldap-dn=`"OU=Clint Hill, OU=Swindon, OU=AllEmployees, O=easyAsInsurance"` xmlns=`"http://directory.api.de.bpm.tibco.com"`> <attribute name="`employeetype`" xmlns=""> <value>`Permanent`</value> </attribute> <attribute name="`manager`" xmlns=""> <value>`ou=John Eustace,ou=Swindon,ou=AllEmployees,o=easyAsInsurance`</value> </attribute> </getLdapEntryResponse> </SOAP-ENV:Body>