Get User Id using REST or JavaScript Object Model

Sometimes you would need to fetch the User Id based on either Login name or Email id. You would need User Id if you need to assign a user object to a people picker control or People/Group field.

How do we get the Id based on Email or Login Name in client side development? We can achieve that using JavaScript Object Model or REST API. Let me share the first example using JavaScript Object Model (JSOM).

var context = new SP.ClientContext.get_current();

this.user = context.get_web().ensureUser(loginName or Email);



var o = { d: d, user: this.user };



context.load(this.user);

context.executeQueryAsync(

    Function.createDelegate(o, ensureUserSuccess),

    Function.createDelegate(o, Fail)

);

The above code fetches User Id for a given Login Name or Email Id.

Interestingly, there is no equivalent endpoint available in REST! The Microsoft documentation talk about a endpoint but I could not get it working.

So what is the way to get User Id using REST? You have to use the hidden User Information List. This list contains details about all the users in a SharePoint site. Just like any other List, you can use REST call to fetch data from this list. The REST url looks something like below:

_spPageContextInfo.webAbsoluteUrl + "/_api/web/SiteUserInfoList/items?$filter=EMail eq '" + EmailId + "'";

By using the above Url in a ajax call, you can get all the user information including Id.

In case you need to get User Id of a logged in user, you don't have to use any of the above methods, as it is readily available by querying _spPageContextInfo.userId property.

Comments

Document ID Service - New Feature in SharePoint

When I explored this new feature of SharePoint in Online (this feature is available in SharePoint 2013 also), I found it interesting because it solved one of the common problems people faced in SharePoint. I will first explain about this feature and I'll cover the problem and the solution in another post. This feature allows Site Collection Admin assign a unique ID to every document in the site collection out of the box. If you recall, there was no out of the box way to assign a unique number to the documents across libraries in a site collection. Yes ID column is unique but only within a library. Document ID column contains a number which is unique across libraries. To start with, let's have a look at a typical document library. This is a familiar view for SP guys. By default, you don't get Document ID column in a library. All Items View To get Document ID column, you need to activate a site collection feature "Document ID Service" as shown below. S...

How to update Person field with multiple values using REST API

Person or Group field in SharePoint is similar to a Lookup field. When you are updating this field using REST API, you need to append "Id" to the name of the column in the body construct. For example, the body construct looks like this: data: { "__metadata": { "type": "SP.Data. ListName ListItem" }, "Title": "First Item", " PeopleField Id": "4" }; The highlighted portions should be replaced by the actual List Name and Column Name. In the above example, the REST call is updating a List item with Title and People columns. How to get the value for user ID ("4" in the above example) needs a separate explanation and that will be my next post! The above example works fine if Person field is configured to accept only one value. If we change the Person field to accept multiple values, how do we pass more than one value in the REST call? Since we normally separate user names with semicolon in peop...

Restrict Future or Past Date in List

Many a times you will come across a requirement wherein you need to restrict user from entering future or past date in a List or Document Library Date column. Developers are inclined towards writing either event handler or javascript to achieve this. But, hold on! You can achieve this without writing a single line of code. I have a list which stores Employee details like Employee Number, Name and Date of Joining. Here I need to enure that Date of Joining will not accept future date. Navigate to List Settings -> Validation Settings. Here you can enter the formula to restrict future date as shown below. If you change the logical operator, it will restrict past date. Also, you can put message which will be displayed to user. Now, when you try to enter future date and try Save, you will see the validation message. So, next time you have similar requirement, you know where to try first before jumping into coding!

SharePoint

Search This Blog