Searching Users in AD through REST in sharepoint?

Question

Any ideas on trying to find/search users by id in Sharepoint by a REST query?

At the moment I am playing around with the clientside people picker to search for users https://msdn.microsoft.com/en-us/library/office/jj713593.aspx

I can also use this endpoint to search for users by their id.

    /_api/web/siteusers?$filter=substringof( '" + id + "',LoginName)

To get something like this

    "Id": 2,
    "LoginName": "i:0#.w|domain\\id",
    "Title": "Generic Name",
    "Email": "[email protected]",

But that only works for users that are in the siteusers and not everyone in AD.

I have also tried searching through this.

/_api/search/query?querytext='AccountName=domain\\id'&sourceid='b09a7990-05ea-4af9-81ef-edfab16c4e31'

But I'm not sure exactly the data is returning since look likes it's in rows and it doesn't look like it's returning any names when looked at it in a REST console.

Answer 1

You can use following end-point. It can search users from all directories.

var userSearchSuggestionEndpoint = "/_api/SP.UI.ApplicationPages.ClientPeoplePickerWebServiceInterface.clientPeoplePickerSearchUser";

HTTP post request is needed to get data from above end-point. Request payload is given below.

var data = {
    queryParams: {
        __metadata: {
            type: 'SP.UI.ApplicationPages.ClientPeoplePickerQueryParameters'
        },
        AllowEmailAddresses: true, 
        AllowMultipleEntities: false, 
        AllUrlZones: false, 
        MaximumEntitySuggestions: 50, 
        PrincipalSource: 15, 
        PrincipalType: 15,
        QueryString: "Your search string"
        Required: false, 
        SharePointGroupID: null, 
        UrlZone: null,
        UrlZoneSpecified: false, 
        Web: null,
        WebApplicationID: null
    }
}

See more about SP.UI.ApplicationPages.ClientPeoplePickerQueryParameters in MSDN.

It does not provide user Id. That's why I personally like following end-point.

var userSearchSuggestionEndpoint = "/_vti_bin/ListData.svc/UserInformationList?
        $select=Id,Name&$filter=substringof('" + searchKey + "',Name)";

I have a complete documentation above client side custom people picker. You can check it out from here.

Answer 2

A little old, but I ran into a similar question these days. This is how I solved it.

The method you are looking for is getproperties for. It's described here

https://msdn.microsoft.com/en-us/library/office/dn790354.aspx#bk_PeopleManagerGetPropertiesFor

Now I had a little difficulty getting the account name for my environment since it doesn't have to be the LoginName. So first to check out the syntax for your accountName I'd use

$.ajax({
        url: siteUrl + "/_api/SP.UserProfiles.PeopleManager/GetMyProperties",
        method: "GET",
        headers: { "Accept": "application/json; odata=verbose" }

    });

Don't forget to escape if the output is something like "domain\username". After that the right call would look like this.

$.ajax({
        url: siteUrl + "_api/getpropertiesfor(@v)?@v='DOM\\USERNAME'",
        method: "GET",
        headers: { "Accept": "application/json; odata=verbose" }

    });

Answer 3

you need to ensure your user on on a site like this - then when a success callback is called, you can query site users endpoint. that way, you will get the id and everything else you need.

var ensureSPUser = function(loginName, callbackSucccess, callbackfailed) {
  var context, usr;
  context = SP.ClientContext.get_current();
  usr = context.get_web().ensureUser(loginName);
  context.load(usr);
  context.executeQueryAsync(callbackSucccess, callbackfailed);
};

Answer 4

To get AD users in Sharepoint you have to put filter as

/_api/web/siteusers?$select=Id,Title,LoginName,Email&$filter=id eq 'Your Id'

Answer 5

Try this:

var murl = _spPageContextInfo.webAbsoluteUrl.split('/sites')[0];

url: murl + /_api/web/siteusers //(filter accordingly).

Worked for me as I was not able to get the user in my Site Collection, I got the details from Web Application.

Answer 6

I would suggest you to either:

• use the PeopleManager REST webservice. Something like this:

  http://[website]/_api/SP.UserProfiles.PeopleManager/GetPropertiesFor(DisplayName=@v)?@v='[target user DisplayName]'

• Or the peoplepicker client solution. Take a look to this explanation.

Regarding how to get the SPuser ID for certain site ( in order to update a people field column for instance ), just use the ensureUser webmethod. Something like this:

        $.ajax({
        url: "http://[website]/_api/web/ensureuser('"+user_name+"')",
        type: "POST",
        headers: {             
            'accept': 'application/json;odata=verbose;charset=utf-8',
            'Content-Type': 'application/json;odata=verbose;charset=utf-8',
            'X-RequestDigest': $("#__REQUESTDIGEST").val()                    
        },
        success: function(response_data){ [your custom success action]
        },
        error: function(response_data){[your custom fail action]}
      });

var user_name will contain target AD username.

NOTE:

• When using the ensureUser method against an AD user, just use its username. So, user_name would be something like this: "username". No need to add "domain\" before neither any other kind of prefix/suffix. Just the username

• ContentType & accept headers MUST be application/json;odata=verbose;charset=utf-8