How to extend IdentityUser with custom property

Question

I'm using asp.net Identity 2.0 for users to log into my website, where the authentication details are stored in an SQL database. Asp.net Identity has been implemented in a standard way as can be found in many online tutorials.

The ApplicationUser class in IdentityModels has been extended to include a custom property:

public class ApplicationUser : IdentityUser { public async Task<ClaimsIdentity> GenerateUserIdentityAsync(UserManager<ApplicationUser> manager, string authenticationType) { CookieAuthenticationOptions.AuthenticationType var userIdentity = await manager.CreateIdentityAsync(this, authenticationType); return userIdentity; } //My extended property public string Code { get; set; } }

When I register a new user I pass the Code custom property in the RegisterBindingModel but I'm not sure how to insert this custom property to the WebUsers table.

I did as bellow but it doesn't actually inserting this property to the table together with the username and password.

var user = new ApplicationUser() { UserName = userName, Email = model.Email, Code=model.Code };

And the entire function:

[AllowAnonymous] [Route("Register")] public async Task<IHttpActionResult> Register(RegisterBindingModel model) { if (!ModelState.IsValid) { return BadRequest(ModelState); } var userName = !string.IsNullOrEmpty(model.UserName) ? model.UserName : model.Email; //I set it here but it doesn't get inserted to the table. var user = new ApplicationUser() { UserName = userName, Email = model.Email, Code=model.Code }; IdentityResult result = await UserManager.CreateAsync(user, model.Password); if (!result.Succeeded) { return GetErrorResult(result); } return Ok(); }

What am I missing? I was looking at similar questions but couldn't find an answer for this.

I think your code is OK, are you sure that the Code property is being filled in the model parameter? — jumuro
– jumuro, Commented Nov 11, 2016 at 11:37
Yes I'm sure, I checked it. But when I check the table in the database, the new user comes up but the code field is always null. — user3378165
– user3378165, Commented Nov 11, 2016 at 13:26
How is the UserManager defined? Have a look at github.com/tjoudeh/AspNetIdentity.WebApi — Sir Rufo
– Sir Rufo, Commented Nov 13, 2016 at 20:44
Probably you are sure that you followed all steps to add property to user correctly, anyway I shared all steps with descriptions. Give it a try, I added Code field successfully by following these steps ↓ — Reza Aghaei
– Reza Aghaei, Commented Nov 13, 2016 at 22:19

Reza Aghaei · Accepted Answer · 2019-10-11 07:29:52Z

If you follow all steps of adding a custom field to user, you will finish the tasks successfully.

Here is all steps to add a custom field to user:

Create an ASP.NET Web Application
Make sure you select MVC and the Authentication is Individual User Accounts
Go to Models folder → Open IdentityModels.cs → ApplicationUser class and add the property:
```
public string Code { get; set; } 
```
Build the project
Go to TOOLS menu → Nuget Package Manager → click Package Manager Console

Type Enable-Migrations and press Enter and wait until the task get completed. You will see a response which says:

 Checking if the context targets an existing database... Code First Migrations enabled for project WebApplication1.

Type Add-Migration "Code" and press Enter and wait until the task get completed. You will see a response which says:

Scaffolding migration 'Code'. The Designer Code for this migration file includes a snapshot of your current Code First model. This snapshot is used to calculate the changes to your model when you scaffold the next migration. If you make additional changes to your model that you want to include in this migration, then you can re-scaffold it by running 'Add-Migration Code' again.

Type Update-Database and press Enter and wait until the task get completed. You will see a response which says:
```
Specify the '-Verbose' flag to view the SQL statements being applied to the target database. Applying explicit migrations: [201611132135242_Code]. Applying explicit migration: 201611132135242_Code. Running Seed method. 
```
At this step if you refresh SQL Server Object Explorer and go to database and see tables, under dbo.AspNetUsers under columns, you will see the Code field. If you didn't know which database or even which server you should look for, open Web.Config file and take a look at connection string which is something like this:
```
<add name="DefaultConnection" connectionString="Data Source=(LocalDb)\v11.0;AttachDbFilename=|DataDirectory|\aspnet-WebApplication1-20161114125903.mdf;Initial Catalog=aspnet-WebApplication1-20161114125903;Integrated Security=True" providerName="System.Data.SqlClient" /> 
```
You can see data source (which is sql server instance) and something .mdf which is database name.
Go to Models folder → Open AccountViewModels.cs file → RegisterViewModel class and add this property: (In APIv2 with EF6, you can add the below line in Models folder → AccountBindingModels file → RegisterBindingModel class)
```
public string Code { get; set; } 
```

Go to Views folder → Account folder → Open Register.cshtml file and add this code near other fields, for example below password:

<div class="form-group"> @Html.LabelFor(m => m.Code, new { @class = "col-md-2 control-label" }) <div class="col-md-10"> @Html.TextBoxFor(m => m.Code, new { @class = "form-control" }) </div> </div>

Go to Controllers folder → Open AccountController.cs file → in http post Register action, change the line which creates user to this:
```
var user = new ApplicationUser { UserName = model.Email, Email = model.Email, Code= model.Code }; 
```
Run project and go to /Account/Register url and register a new user. After registering the user, if you go to database again and View Data of dbo.AspNetUsers table, you will see the code has been saved.

Download

You can clone or download a working example here:

r-aghaei/AddPropertyToIdentityUserExample

Further reading - How to Add a custom Property to IdentityRole?

If you are interested to know how to add a new property to IdentityRole, take a look at How to Add a custom Property to IdentityRole?

Thank you for the clear and detailed answer, the only one step that I'm missing is: #9: "Go to Models folder → Open AccountViewModels.cs file → RegisterViewModel class ", on my AccountViewModels.cs file there is no a RegisterViewModel class, should I add it? Thank you!
You're welcome. You will need it. If you don't need, there will not be a Code in passed model from View.
Follow instructions in a clean solution and it will be clear for you what you are doing.
I'm not passing the Code from the View. I'm calling the API from a totally different project.
When I register through the Register View I don't pass it as a parameter. What could be the issue? Thank you very much for your help!

Ben-Carpenter · Accepted Answer · 2018-07-07 18:29:42Z

Hope this might help others, since the original post is 1+years old

If have already created the project with 'Authentication Individual User Accounts:

In Solution Explorer go to project>Models>IdentityModels.cs

under public class ApplicationUser: IdentityUser (should be the first class).

Add your custom properties after public async Task<ClaimsIdentity> GenerateUserIdentityAsync(UserManager<ApplicationUser> manager) like my example below:

public class ApplicationUser : IdentityUser { public async Task<ClaimsIdentity> GenerateUserIdentityAsync(UserManager<ApplicationUser> manager) { // Note the authenticationType must match the one defined in CookieAuthenticationOptions.AuthenticationType var userIdentity = await manager.CreateIdentityAsync(this, DefaultAuthenticationTypes.ApplicationCookie); // Add custom user claims here return userIdentity; } **//add custom properties here - these are just examples** public bool SendEmails { get; set; } public string FirstName { get; set; } public string LastName { get; set; } }

Then using NuGet Packagemanager:

enable-migrations (if you haven't already)
add-migration [enter]
nameYourMigration [enter]
(view the migration file to verify your properties are going to be added)
update-database [enter]
Check your AspNetUsers db table to be sure the properties were added correctly

I hope this helps..

VerySeriousSoftwareEndeavours · Accepted Answer · 2019-08-13 06:04:29Z

I think the main problem still is you don't register the new claims at the ApplicationUser class.

I was having the same problem and I solved it with a few lines after the CreateIdentityAsync.

public class ApplicationUser : IdentityUser { public async Task<ClaimsIdentity> GenerateUserIdentityAsync(UserManager<ApplicationUser> manager, string authenticationType) { CookieAuthenticationOptions.AuthenticationType var userIdentity = await manager.CreateIdentityAsync(this, authenticationType); // Add custom user claims here userIdentity.AddClaim(new Claim("Code",this.Code)); return userIdentity; } //My extended property public string Code { get; set; } }

Collectives™ on Stack Overflow

How to extend IdentityUser with custom property

3 Answers 3

12 Comments

Hope this might help others, since the original post is 1+years old

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

12 Comments

Hope this might help others, since the original post is 1+years old

Comments

Comments

Linked

Related