Class IdentityUser
Inheritance
System.Object
IdentityUser
Implements
IHasExtraProperties
IMultiTenant
Assembly: Volo.Abp.Identity.Domain.dll
Syntax
public class IdentityUser : FullAuditedAggregateRoot<Guid>, IAggregateRoot<Guid>, IEntity<Guid>, IGeneratesDomainEvents, IHasExtraProperties, IHasConcurrencyStamp, ICreationAuditedObject, IAuditedObject, IFullAuditedObject, IUser, IAggregateRoot<Guid>, IEntity<Guid>, IAggregateRoot, IEntity, IMultiTenant
Constructors
IdentityUser()
Declaration
IdentityUser(Guid, String, String, Nullable<Guid>)
Declaration
public IdentityUser(Guid id, string userName, string email, Guid? tenantId = null)
Parameters
Type |
Name |
Description |
Guid |
id |
|
System.String |
userName |
|
System.String |
email |
|
System.Nullable<Guid> |
tenantId |
|
Properties
AccessFailedCount
Gets or sets the number of failed login attempts for the current user.
Declaration
public virtual int AccessFailedCount { get; protected set; }
Property Value
Type |
Description |
System.Int32 |
|
Claims
Navigation property for the claims this user possesses.
Declaration
public virtual ICollection<IdentityUserClaim> Claims { get; protected set; }
Property Value
Email
Gets or sets the email address for this user.
Declaration
public virtual string Email { get; protected set; }
Property Value
Type |
Description |
System.String |
|
EmailConfirmed
Gets or sets a flag indicating if a user has confirmed their email address.
Declaration
public virtual bool EmailConfirmed { get; protected set; }
Property Value
Type |
Description |
System.Boolean |
True if the email address has been confirmed, otherwise false.
|
IsExternal
Declaration
public virtual bool IsExternal { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
LockoutEnabled
Gets or sets a flag indicating if the user could be locked out.
Declaration
public virtual bool LockoutEnabled { get; protected set; }
Property Value
Type |
Description |
System.Boolean |
True if the user could be locked out, otherwise false.
|
LockoutEnd
Gets or sets the date and time, in UTC, when any user lockout ends.
Declaration
public virtual DateTimeOffset? LockoutEnd { get; protected set; }
Property Value
Type |
Description |
System.Nullable<DateTimeOffset> |
|
Logins
Navigation property for this users login accounts.
Declaration
public virtual ICollection<IdentityUserLogin> Logins { get; protected set; }
Property Value
Name
Gets or sets the Name for the user.
Declaration
public virtual string Name { get; set; }
Property Value
Type |
Description |
System.String |
|
NormalizedEmail
Gets or sets the normalized email address for this user.
Declaration
public virtual string NormalizedEmail { get; protected set; }
Property Value
Type |
Description |
System.String |
|
NormalizedUserName
Gets or sets the normalized user name for this user.
Declaration
public virtual string NormalizedUserName { get; protected set; }
Property Value
Type |
Description |
System.String |
|
OrganizationUnits
Navigation property for this organization units.
Declaration
public virtual ICollection<IdentityUserOrganizationUnit> OrganizationUnits { get; protected set; }
Property Value
PasswordHash
Gets or sets a salted and hashed representation of the password for this user.
Declaration
public virtual string PasswordHash { get; protected set; }
Property Value
Type |
Description |
System.String |
|
PhoneNumber
Gets or sets a telephone number for the user.
Declaration
public virtual string PhoneNumber { get; protected set; }
Property Value
Type |
Description |
System.String |
|
PhoneNumberConfirmed
Gets or sets a flag indicating if a user has confirmed their telephone address.
Declaration
public virtual bool PhoneNumberConfirmed { get; protected set; }
Property Value
Type |
Description |
System.Boolean |
True if the telephone number has been confirmed, otherwise false.
|
Roles
Navigation property for the roles this user belongs to.
Declaration
public virtual ICollection<IdentityUserRole> Roles { get; protected set; }
Property Value
SecurityStamp
A random value that must change whenever a users credentials change (password changed, login removed)
Declaration
public virtual string SecurityStamp { get; protected set; }
Property Value
Type |
Description |
System.String |
|
Surname
Gets or sets the Surname for the user.
Declaration
public virtual string Surname { get; set; }
Property Value
Type |
Description |
System.String |
|
TenantId
Declaration
public virtual Guid? TenantId { get; protected set; }
Property Value
Type |
Description |
System.Nullable<Guid> |
|
Tokens
Navigation property for this users tokens.
Declaration
public virtual ICollection<IdentityUserToken> Tokens { get; protected set; }
Property Value
TwoFactorEnabled
Gets or sets a flag indicating if two factor authentication is enabled for this user.
Declaration
public virtual bool TwoFactorEnabled { get; protected set; }
Property Value
Type |
Description |
System.Boolean |
True if 2fa is enabled, otherwise false.
|
UserName
Gets or sets the user name for this user.
Declaration
public virtual string UserName { get; protected set; }
Property Value
Type |
Description |
System.String |
|
Methods
AddClaim(IGuidGenerator, Claim)
Declaration
public virtual void AddClaim(IGuidGenerator guidGenerator, Claim claim)
Parameters
Type |
Name |
Description |
IGuidGenerator |
guidGenerator |
|
Claim |
claim |
|
AddClaims(IGuidGenerator, IEnumerable<Claim>)
Declaration
public virtual void AddClaims(IGuidGenerator guidGenerator, IEnumerable<Claim> claims)
Parameters
Type |
Name |
Description |
IGuidGenerator |
guidGenerator |
|
IEnumerable<Claim> |
claims |
|
AddLogin(UserLoginInfo)
Declaration
public virtual void AddLogin(UserLoginInfo login)
Parameters
Type |
Name |
Description |
UserLoginInfo |
login |
|
AddOrganizationUnit(Guid)
Declaration
public virtual void AddOrganizationUnit(Guid organizationUnitId)
Parameters
Type |
Name |
Description |
Guid |
organizationUnitId |
|
AddRole(Guid)
Declaration
public virtual void AddRole(Guid roleId)
Parameters
Type |
Name |
Description |
Guid |
roleId |
|
FindClaim(Claim)
Declaration
public virtual IdentityUserClaim FindClaim(Claim claim)
Parameters
Type |
Name |
Description |
Claim |
claim |
|
Returns
FindToken(String, String)
Declaration
public virtual IdentityUserToken FindToken(string loginProvider, string name)
Parameters
Type |
Name |
Description |
System.String |
loginProvider |
|
System.String |
name |
|
Returns
IsInOrganizationUnit(Guid)
Declaration
public virtual bool IsInOrganizationUnit(Guid organizationUnitId)
Parameters
Type |
Name |
Description |
Guid |
organizationUnitId |
|
Returns
Type |
Description |
System.Boolean |
|
IsInRole(Guid)
Declaration
public virtual bool IsInRole(Guid roleId)
Parameters
Type |
Name |
Description |
Guid |
roleId |
|
Returns
Type |
Description |
System.Boolean |
|
RemoveClaim(Claim)
Declaration
public virtual void RemoveClaim(Claim claim)
Parameters
Type |
Name |
Description |
Claim |
claim |
|
RemoveClaims(IEnumerable<Claim>)
Declaration
public virtual void RemoveClaims(IEnumerable<Claim> claims)
Parameters
Type |
Name |
Description |
IEnumerable<Claim> |
claims |
|
RemoveLogin(String, String)
Declaration
public virtual void RemoveLogin(string loginProvider, string providerKey)
Parameters
Type |
Name |
Description |
System.String |
loginProvider |
|
System.String |
providerKey |
|
RemoveOrganizationUnit(Guid)
Declaration
public virtual void RemoveOrganizationUnit(Guid organizationUnitId)
Parameters
Type |
Name |
Description |
Guid |
organizationUnitId |
|
RemoveRole(Guid)
Declaration
public virtual void RemoveRole(Guid roleId)
Parameters
Type |
Name |
Description |
Guid |
roleId |
|
RemoveToken(String, String)
Declaration
public virtual void RemoveToken(string loginProvider, string name)
Parameters
Type |
Name |
Description |
System.String |
loginProvider |
|
System.String |
name |
|
ReplaceClaim(Claim, Claim)
Declaration
public virtual void ReplaceClaim(Claim claim, Claim newClaim)
Parameters
Type |
Name |
Description |
Claim |
claim |
|
Claim |
newClaim |
|
SetEmailConfirmed(Boolean)
Use for regular email confirmation.
Using this skips the confirmation process and directly sets the EmailConfirmed.
Declaration
public virtual void SetEmailConfirmed(bool confirmed)
Parameters
Type |
Name |
Description |
System.Boolean |
confirmed |
|
SetPhoneNumber(String, Boolean)
Normally use to change the phone number
in the application code.
This method is to directly set it with a confirmation information.
Declaration
public void SetPhoneNumber(string phoneNumber, bool confirmed)
Parameters
Type |
Name |
Description |
System.String |
phoneNumber |
|
System.Boolean |
confirmed |
|
SetPhoneNumberConfirmed(Boolean)
Declaration
public virtual void SetPhoneNumberConfirmed(bool confirmed)
Parameters
Type |
Name |
Description |
System.Boolean |
confirmed |
|
SetToken(String, String, String)
Declaration
public virtual void SetToken(string loginProvider, string name, string value)
Parameters
Type |
Name |
Description |
System.String |
loginProvider |
|
System.String |
name |
|
System.String |
value |
|
ToString()
Declaration
public override string ToString()
Returns
Type |
Description |
System.String |
|
Overrides
Volo.Abp.Domain.Entities.Entity<Guid>.ToString()
Implements
IHasExtraProperties
IMultiTenant
Extension Methods