How do you get the UserID of a User object in ASP.Net MVC?
Asked Answered
D

11

74

I have some tables that have a uniqueidentifier UserID that relates to aspnet_Users.UserID. When the user submits some data for those tables, since the controller method has an [Authorize] I get a User object. I can get the username with User.Identity.Name, but how do I get the UserID to be able to establish (the ownership) relationship?

Delossantos answered 29/5, 2009 at 6:45 Comment(3)
the question doesn't really have anything to do with mvc so i retagged from asp-net-mvc to asp-net to get the better audience to look at this.Countermarch
Kris, ASP.Net MVC provides a User object that I don't think ASP.Net provides. Am I wrong?Delossantos
Yep, you're wrong. Kris is right. it's an ASP.NET thing, not just ASP.NET MVC.Oz
D
87

It seems you cannot get it from the User object but you can get it this way:

Guid userGuid = (Guid)Membership.GetUser().ProviderUserKey;
Delossantos answered 29/5, 2009 at 19:58 Comment(4)
Really? it doesn't require a string? /me checks msdn: msdn.microsoft.com/en-us/library/… . Sh|t! u're right! good find :)Oz
In the OAuth stuff that has been introduced, this doesn't work (null returned). In ASP.Net 4 MVC you can use the WebSecurity.CurrentUserId propertyRufescent
@Dann it appears that in ASP.Net MVC 5 this no longer works, or they changed the using statements (was using System.Web.Security). Any ideas?Narcoma
MVC 5 solution: #18449137Acetous
I
31

Here is the solution:

Include:

using Microsoft.AspNet.Identity;

Then use extension methods:

User.Identity.GetUserId();
Inspection answered 30/1, 2014 at 12:55 Comment(0)
O
28

Firstly, this answer is not strictly an MVC answer, but an ASP.NET answer. The fact that your site is MVC is irrelevant to solving the problem, in this case.


Hmm. I'm not very sure how you are handling your users in your system but it sounds like you using the (very evil) asp.net membership provider that comes out of the box with .net. This is hinted by the fact that you said

  • aspnet_Users.UserID
  • UserID is a uniqueidentifier (read: GUID).

With the default forms authentication system, which uses the default FormsIdentity, it only has a single property called Name (as you correctly noted). This means it has only one value where to place some unique user information. In your case, you are putting Name/UserName/DisplayName, in the Name property. I'm assuming this name is their Display Name and it is unique. Whatever value you are putting in here, it HAS TO BE UNIQUE.

From this, you can grab the user's guid.

Check this out.

using System.Web.Security;

....

// NOTE: This is a static method .. which makes things easier to use.
MembershipUser user = Membership.GetUser(User.Identity.Name);
if (user == null)
{
    throw new InvalidOperationException("User [" + 
        User.Identity.Name + " ] not found.");
}

// Do whatever u want with the unique identifier.
Guid guid = (Guid)user.ProviderUserKey;

So, every time you wish to grab the user information, you need to grab it from the database using the static method above.

Read all about the Membership class and MembershipUser class on MSDN.

Bonus Answer / Suggestion

As such, i would CACHE that result so you don't need to keep hitting the database.

... cont from above....
Guid guid = (Guid)user.ProviderUserKey;

Cache.Add(User.Identity.Name, user.UserID); // Key: Username; Value: Guid.

Otherwise, you can create your own Identity class (which inherits from IIdentity) and add your own custom properties, like UserID. Then, whenever you authenticate (and also on every request) you can set this value. Anyway, this is a hard core solution, so go with the caching, right now.

HTH

Oz answered 29/5, 2009 at 12:36 Comment(4)
Is that the way to do it? Making the name of the user unique? What do we have IDs for at all then?Delossantos
OT: Why do you claim the ASP.NET Membership is evil?Lightness
@Eric: because i personally feel that it's a massively overengineered solution for the majority of scenario's. For example, how many times do u see a solution that shares a common sql server where the users are shared across databases, on that same sql server? All those tables and stored procs, which can be cut down to just one or two for the majority of scenario's people do. Summary: massive bloat. Over enginereed. Side note: OpenID FTW now :)Oz
@J. Pablo: no mate. The ID is the main thing that is unique, but the Membership.GetUser(string) gets the user by the string provided -> generally their username. If u don't provide that string, it uses the current value for whoever is logged in, assuming someone IS logged in. That value is the equivalent of User.Identity.Name.Oz
M
18

User.Identity is an IPrincipal - typically of type System.Web.Security.FormsIdentity

It doesn't know anything about UserIDs - it's just an abstraction of the concept of an 'identity'.

The IIdentity interface only has 'Name' for a user, not even 'Username'.

If you're using MVC4 with the default SimpleMembershipProvider you can do this:

WebSecurity.GetUserId(User.Identity.Name)   // User is on ControllerBase

(Where WebSecurity is in the nuget package Microsoft.AspNet.WebPages.WebData in WebMatrix

You can also use

WebSecurity.CurrentUserName
WebSecurity.CurrentUserId

(if you're using ASPNetMembershipProvider which is the older more complex ASPNET membership system then see the answer by @eduncan911)

Mirthless answered 17/1, 2013 at 3:8 Comment(1)
+1 for WebSecurity.CurrentUserId. Even the templated AccountController uses WebSecurity.GetUserId(User.Identity.Name) which seems a little daft when it has CurrentUserId available.Pediform
L
11

If you are using the ASP.NET Membership (which in turn uses the IPrincipal object):

using System.Web.Security;
{
  MembershipUser user = Membership.GetUser(HttpContext.User.Identity.Name);
  Guid guid = (Guid)user.ProviderUserKey;
}

User.Identity always returns the state of the current user, logged in or not.

Anonymous or not, etc. So a check for is logged in:

if (User.Identity.IsAuthenticated)
{
  ...
}

So, putting it all together:

using System.Web.Security;
{
  if (User.Identity.IsAuthenticated)
  {
    MembershipUser user = Membership.GetUser(HttpContext.User.Identity.Name);
    Guid guid = (Guid)user.ProviderUserKey;
  }
}
Lightness answered 29/5, 2009 at 20:8 Comment(0)
J
6

Best Option to Get User ID

Add Below references

using Microsoft.AspNet.Identity;
using Microsoft.AspNet.Identity.EntityFramework;
using Microsoft.Owin.Security;*

public myFunc()
{
   .....
   // Code which will give you user ID is 
   var tmp = User.Identity.GetUserId();

}
Jefferyjeffie answered 9/1, 2014 at 2:39 Comment(0)
B
3

If you are using your own IPrincipal object for authorization, you just need to cast it to access the Id.

For example:

public class MyCustomUser : IPrincipal
{
    public int UserId {get;set;}

    //...Other IPrincipal stuff
}

Here is a great tutorial on creating your own Form based authentication.

http://www.codeproject.com/KB/web-security/AspNetCustomAuth.aspx

That should get you on the right path to creating an authentication cookie for your user and accessing your custom user data.

Birthstone answered 29/5, 2009 at 14:39 Comment(0)
A
2
using System.Web.Security;

MembershipUser user = Membership.GetUser(User.Identity.Name); 
int id = Convert.ToInt32(user.ProviderUserKey);
Aegospotami answered 27/2, 2014 at 18:8 Comment(0)
G
1

Its the ProviderUserKey property.

System.Web.Security.MembershipUser u;
u.ProviderUserKey
Glyco answered 29/5, 2009 at 7:17 Comment(1)
How would I get u to be the current logged in user?Delossantos
T
1

Simple....

int userID = WebSecurity.CurrentUserId;
Thad answered 5/8, 2013 at 9:54 Comment(1)
While it is one of the more useful solutions, this answer was covered by Simon_Weaver's answer (7 months earlier).Pediform
M
0

Usually you can just use WebSecurity.currentUserId, but if you're in AccountController just after the account has been created and you want to use the user id to link the user to some data in other tables then WebSecurity.currentUserId (and all of the solutions above), unfortunately, in that case returns -1, so it doesn't work.

Luckily in this case you have the db context for the UserProfiles table handy, so you can get the user id by the following:

UserProfile profile = db.UserProfiles.Where(
    u => u.UserName.Equals(model.UserName)
).SingleOrDefault();

I came across this case recently and this answer would have saved me a whole bunch of time, so just putting it out there.

Metheglin answered 15/12, 2015 at 10:55 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.