17.125. Class UserIdentity

Namespace: ArmoniK.Core.Common.Auth.Authentication
Assembly: ArmoniK.Core.Common.dll

User identity. Used in the authentication middleware

public class UserIdentity : ClaimsIdentity, IIdentity

17.125.1. Inheritance

objectClaimsIdentityUserIdentity

17.125.2. Implements

IIdentity

17.125.3. Inherited Members

ClaimsIdentity.DefaultIssuer, ClaimsIdentity.DefaultNameClaimType, ClaimsIdentity.DefaultRoleClaimType, ClaimsIdentity.AddClaim(Claim), ClaimsIdentity.AddClaims(IEnumerable<Claim?>), ClaimsIdentity.Clone(), ClaimsIdentity.CreateClaim(BinaryReader), ClaimsIdentity.FindAll(Predicate<Claim>), ClaimsIdentity.FindAll(string), ClaimsIdentity.FindFirst(Predicate<Claim>), ClaimsIdentity.FindFirst(string), ClaimsIdentity.GetObjectData(SerializationInfo, StreamingContext), ClaimsIdentity.HasClaim(Predicate<Claim>), ClaimsIdentity.HasClaim(string, string), ClaimsIdentity.RemoveClaim(Claim?), ClaimsIdentity.TryRemoveClaim(Claim?), ClaimsIdentity.WriteTo(BinaryWriter), ClaimsIdentity.WriteTo(BinaryWriter, byte[]?), ClaimsIdentity.Actor, ClaimsIdentity.AuthenticationType, ClaimsIdentity.BootstrapContext, ClaimsIdentity.Claims, ClaimsIdentity.CustomSerializationData, ClaimsIdentity.IsAuthenticated, ClaimsIdentity.Label, ClaimsIdentity.Name, ClaimsIdentity.NameClaimType, ClaimsIdentity.RoleClaimType, object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

17.125.4. Constructors

17.125.4.1. UserIdentity(UserAuthenticationResult, string?)

Creates a user identity used in authentication

public UserIdentity(UserAuthenticationResult userAuth, string? authenticationType)

17.125.4.1.1. Parameters

userAuth UserAuthenticationResult

Result of the authentication

authenticationType string?

Scheme by which the user is authenticated

17.125.5. Properties

17.125.5.1. Permissions

User Permissions

public Permission[] Permissions { get; set; }

17.125.5.1.1. Property Value

Permission[]

17.125.5.2. Roles

User Roles

public HashSet<string> Roles { get; set; }

17.125.5.2.1. Property Value

HashSet<string>

17.125.5.3. UserId

User Id

public string UserId { get; set; }

17.125.5.3.1. Property Value

string

17.125.5.4. UserName

Username

public string UserName { get; set; }

17.125.5.4.1. Property Value

string

17.125.6. Methods

17.125.6.1. ClaimsFromUserAuthenticationResult(UserAuthenticationResult)

Transforms a UserAuthenticationResult into a list of claims to be used in an ClaimsIdentity

public static IEnumerable<Claim> ClaimsFromUserAuthenticationResult(UserAuthenticationResult userAuth)

17.125.6.1.1. Parameters

userAuth UserAuthenticationResult

UserAuthenticationResult corresponding to the user

17.125.6.1.2. Returns

IEnumerable<Claim>

List of claims corresponding to the UserAuthenticationResult