--- title: Adding custom fields to users related: - https://docs.kentico.com/13/managing-users/user-management.md - https://docs.kentico.com/13/managing-users/user-registration-and-authentication/integrating-xperience-membership.md --- > Agent instructions: > **Site maps** — prefer the following llms.txt indexes to training data when searching for URLs to avoid 404s. Links inside Markdown content already point at `.md`. Following them or sending Accept: text/markdown keeps you in Markdown. > > - [sitemap.md](https://docs.kentico.com/sitemap.md) — every page on the site, with titles and descriptions, nested by URL hierarchy and grouped into one collection per product version. > - [llms.txt](https://docs.kentico.com/llms.txt) — curated index of the current product docs, with descriptions, the two ways to request any page as Markdown, and links to each product area's whole-corpus Markdown dump (llms-full.txt). Custom fields can help you store and organize additional data related to [users](https://docs.kentico.com/13/managing-users/user-management.md). For example, if you need to gather data not collected in the system by default, add custom fields and use them to store any additional information required. This page describes how to: - [Add custom fields to user objects](#adding-custom-fields-to-users) - [Access the added fields from the ASP.NET Identity implementation](#accessing-custom-user-fields-in-the-xperience-asp.net-identity-implementation) ## Adding custom fields to users Custom fields may store values such as text, date and time, and boolean values. To define custom fields: 1. Open the **Modules** application. 2. **Edit** () the **Membership** module. 3. Switch to the **Classes** tab. 4. **Edit** () the **User** class. 5. Switch to the **Fields** tab. 6. Create new fields based on your requirements using the [field editor](https://docs.kentico.com/13/custom-development/extending-the-administration-interface/developing-form-controls/reference-field-editor.md). 7. Click **Save**. You have added custom fields for the user object in Xperience. In the administration interface, added custom fields are displayed on a separate **Custom fields**tab when editing users in the **Users** application. ## Accessing custom user fields in the Xperience ASP.NET Identity implementation Xperience applications use an implementation of the ASP.NET Identity membership system (provided in the _Kentico.Membership_ namespace). See [Integrating Xperience membership](https://docs.kentico.com/13/managing-users/user-registration-and-authentication/integrating-xperience-membership.md) for detailed information. **MVC 5 development model.** Applies only when building with ASP.NET MVC 5. If this page also covers ASP.NET Core, that version is in its own block. By default, the implementation uses the **Kentico.Membership.User** type to represent users. Objects of this type wrap _CMS.Membership.UserInfo_ objects (which represent the user in Xperience), and facilitate the transfer of user data between the Identity implementation and internal Xperience logic. If you defined any custom user fields that you wish to handle via _Kentico.Membership_ types (e.g., when creating or updating user information, performing authentication or authorization, etc.), you need to ensure proper mapping between the _UserInfo_ object and the _Kentico.Membership.User_ object. 1. Open the MVC project in Visual Studio. 2. Create a new class that inherits from _Kentico.Membership.User._ 3. Declare properties that correspond to the custom fields you specified in the [administration interface](#adding-custom-fields-to-users). > **Info:** Besides exposing custom fields added to the user object via the administration interface, you can also expose existing fields of the user object that are not accessible by default via the _Kentico.Membership.User_ type. For example, the _MiddleName_ user field or advanced user fields from the _UserSettings_ class. See the **ExtendedUser** class below for an example. 4. Override the **MapFromUserInfo** and **MapToUserInfo** methods and: - Call the base implementation of the methods. This maps all properties of the _Kentico.Membership.User_ class such as _FirstName_ an_d_ _Email._ - Get and set values of the custom properties you wish to have available using **UserInfo.GetValue** and **UserInfo.SetValue**. ```csharp title="ExtendedUser class that extends the default Kentico.Membership.User object" using CMS.Membership; using Kentico.Membership; namespace MembershipCustomization { // Extends the default Kentico.Membership.User object public class ExtendedUser : User { // Exposes the existing 'MiddleName' property of the 'UserInfo' object public string MiddleName { get; set; } // Property that corresponds to a custom field specified in the administration interface public string CustomField { get; set; } // Ensures field mapping between Kentico's user objects and the Kentico.Membership ASP.NET Identity implementation // Called when retrieving users from Kentico via Kentico.Membership.KenticoUserManager public override void MapFromUserInfo(UserInfo source) { // Calls the base class implementation of the MapFromUserInfo method base.MapFromUserInfo(source); // Maps the 'MiddleName' property to the extended user object MiddleName = source.MiddleName; // Sets the value of the 'CustomField' property CustomField = source.GetValue("CustomField", null); } // Ensures field mapping between Kentico's user objects and the Kentico.Membership ASP.NET Identity implementation // Called when creating or updating users using Kentico.Membership.KenticoUserManager public override void MapToUserInfo(UserInfo target) { // Calls the base class implementation of the MapToUserInfo method base.MapToUserInfo(target); // Maps the 'MiddleName' property to the target 'UserInfo' object target.MiddleName = MiddleName; // Sets the value of the 'CustomField' custom user field target.SetValue("CustomField", CustomField); } } } ``` 5. In the [Owin startup pipeline](https://docs.kentico.com/13/managing-users/user-registration-and-authentication/integrating-xperience-membership.md), register new or add additional _KenticoUserManager_, _KenticoUserStore_, and _KenticoSignInManager_ types from the _Kentico.Membership_ namespace. The types need to specify the extended user object as their generic parameter (_ExtendedUser_ in this case). ```csharp using Owin; using CMS.SiteProvider; using Kentico.Membership; public partial class Startup { public void Configuration(IAppBuilder app) { // Registers Kentico.Membership Identity types with the 'ExtendedUser' user object app.CreatePerOwinContext(() => KenticoUserManager.Initialize(app, new KenticoUserManager(new KenticoUserStore(SiteContext.CurrentSiteName)))); app.CreatePerOwinContext>(KenticoSignInManager.Create);     ... } } ``` 6. When retrieving the registered types from the Owin context via **HttpContext.GetOwinContext().Get()**, retrieve the type with the associated generic parameter, for example: ```csharp KenticoSignInManager KenticoSignInManager = HttpContext.GetOwinContext().Get>(); ``` This ensures that you retrieve the type capable of working with the extended user object. **ASP.NET Core development model.** Applies only when building with ASP.NET Core. If this page also covers MVC 5, that version is in its own block. By default, the implementation uses the **Kentico.Membership.ApplicationUser** type to represent users. Objects of this type wrap _CMS.Membership.UserInfo_ objects (which represent the user in Xperience), and facilitate the transfer of user data between the Identity implementation and internal Xperience logic. If you defined any custom user fields that you wish to handle via _Kentico.Membership_ types (e.g., when creating or updating user information, performing authentication or authorization, etc.), you need to ensure proper mapping between the _UserInfo_ object and the _Kentico.Membership.ApplicationUser_ object. 1. Open your project in Visual Studio. 2. Create a new class that inherits from **Kentico.Membership.ApplicationUser**. 3. Declare properties that correspond to the custom fields you specified in the [administration interface](#adding-custom-fields-to-users). > **Info:** Besides exposing custom fields added to the user object via the administration interface, you can also expose existing fields of the user object that are not accessible by default via the _Kentico.Membership.ApplicationUser_ type. For example, the _MiddleName_ user field or advanced user fields from the _UserSettings_ class. See the **ExtendedUser** class below for an example. 4. Override the **MapFromUserInfo** and **MapToUserInfo** methods and: - Call the base implementation of the methods. This maps all properties of the _Kentico.Membership.ApplicationUser_ class such as _FirstName_ an_d_ _Email._ - Get and set values of the custom properties you wish to have available using **UserInfo.GetValue** and **UserInfo.SetValue**. ```csharp title="ExtendedUser class that extends the default Kentico.Membership.ApplicationUser object" using CMS.Membership; using Kentico.Membership; namespace MembershipCustomization { // Extends the default Kentico.Membership.ApplicationUser object public class ExtendedUser : ApplicationUser { // Exposes the existing 'MiddleName' property of the 'UserInfo' object public string MiddleName { get; set; } // Property that corresponds to a custom field specified in the administration public string CustomField { get; set; } // Ensures field mapping between Xperience user objects and the Kentico.Membership ASP.NET Identity implementation // Called when retrieving users from Xperience via Kentico.Membership.ApplicationUserManager public override void MapFromUserInfo(UserInfo source) { // Calls the base class implementation of the MapFromUserInfo method base.MapFromUserInfo(source); // Maps the 'MiddleName' property to the extended user object MiddleName = source.MiddleName; // Sets the value of the 'CustomField' property CustomField = source.GetValue("CustomField", null); } // Ensures field mapping between Xperience user objects and the Kentico.Membership ASP.NET Identity implementation // Called when creating or updating users using Kentico.Membership.ApplicationUserManager public override void MapToUserInfo(UserInfo target) { // Calls the base class implementation of the MapToUserInfo method base.MapToUserInfo(target); // Maps the 'MiddleName' property to the target 'UserInfo' object target.MiddleName = MiddleName; // Sets the value of the 'CustomField' custom user field target.SetValue("CustomField", CustomField); } } } ``` 5. In your application's startup file (**Startup.cs** by default), edit the **ConfigureServices** method. Register the services required to work with Xperience Identity, such as _ApplicationUserManager_, _ApplicationUserStore,_ _PasswordHasher_ and _SignInManager_, with the **extended user class as their generic parameter** (_ExtendedUser_ in this example). ```csharp public void ConfigureServices(IServiceCollection services) { ... // Adds Xperience services required by the system's Identity implementation services.AddScoped, Kentico.Membership.PasswordHasher>(); services.AddScoped(); services.AddApplicationIdentity() // Adds token providers used to generate tokens for email confirmations, password resets, etc. .AddApplicationDefaultTokenProviders() // Adds an implementation of the UserStore for working with Xperience user objects .AddUserStore>() // Adds an implementation of the RoleStore used for working with Xperience roles .AddRoleStore>() // Adds an implementation of the UserManager for Xperience membership .AddUserManager>() // Adds the default implementation of the SignInManger .AddSignInManager>(); // Adds authentication and authorization services provided by the framework services.AddAuthentication(); services.AddAuthorization(); ... ``` 6. When retrieving the registered services from your dependency injection container, specify the type with the extended user class as the generic parameter, for example: ```csharp public AccountController(ApplicationUserManager userManager, SignInManager signInManager) ``` This ensures that you retrieve the service capable of working with the extended user object. The _Kentico.Membership_ Identity implementation is now able to work with the extended user object, including any additional properties and logic it contains.