REST API - getCandidateDetail

The table summarizes the REST API - getCandidateDetail.

Request

Format
POST <baseurl>/directory/candidates/<containerid>
Path parameters containerid: Identifies the LDAP Container from which the candidate was resolved.
Body xmlContainerLdapEntry (required): the component from the getCandidateDetailResponse element (from the DirectoryService schema) that defines the LDAP candidate to be requested.

Response

JSON Returns a JSON representation of the content of the getCandidateDetailResponse element.
XML Returns the content of the getCandidateDetailResponse element (from the DirectoryService schema).

Example

Request
POST <baseurl>/directory/candidates/1/detail
Request body
<candidate name="Clint Hill" ldap-alias="easyAs" ldap-dn="UID=chill, OU=employees, O=insuranceServices">

<secondary-ref ldap-alias="easyAs" ldap-dn="UID=Clint Hill, OU=GlobalSales, O=insuranceSales"/>

</candidate>
Response
 {

       "xml-fragment":

       {

           "@name": "UID=chill, OU=employees, O=insuranceServices",

           "@container-id": "1",

           "@ldap-alias": "easyAs",

           "@ldap-dn": "UID=chill, OU=employees, O=insuranceServices",

           "secondary-ref":

           {

               "@ldap-alias": "easyAs",

               "@ldap-dn": "UID=Clint Hill, OU=GlobalSales, O=insuranceSales"

           }

       }

    }