REST API - lookupUser

The table summarizes the REST API - lookupUser.

Request

Format 
POST <baseurl>/resourcelookup/findbydn/<version>
Path parameters version: Major version number of the organization model from which the resources' associations (position, group, capability, etc) are to be reported. This parameter is only applied if the detail parameter is true. If not specified, the default value will be the latest version of the organization model.
Query parameters
  • ldapalias=string (optional): LDAP alias to search against for a matching resource.
  • detail=boolean (optional, default=false): Boolean value defining whether to return the details of each matching resource.
Body ldap-dn (required): the component in the createResource element (from the OrgResourceService schema) that defines the LDAP DN to search against for a matching resource.

Response

JSON Returns a JSON representation of the content of a lookupUserResponse element.
XML Returns the content of the lookupUserResponse element (from the EntityResolverService schema).

Example

Request 
POST <baseurl>/resourcelookup/findbydn/-1?detail=true
Request body 
OU=Clint Hill, OU=Swindon, OU=AllEmployees, O=easyAsInsurance
Response 
 {
       "xml-fragment":
       {
           "@user-count": "1",
           "detail":
           {
               "@entity-type": "RESOURCE",
               "@guid": "AF8224B6-FF4F-435D-8D58-DD81100766CD",
               "@name": "Mr Clint Hill",
               "@model-version": "1",
               "@resource-type": "HUMAN",
               "@alias": "easyAs",
               "@dn": "OU=Clint Hill, OU=Swindon, OU=AllEmployees, O=easyAsInsurance"
           }
       }
    }