Class PrincipalExtensions

Namespace

Duende.IdentityServer.Extensions

Assembly

Duende.IdentityServer.dll

Extension methods for IPrincipal and IIdentity .

public static class PrincipalExtensions

Inheritance

object

PrincipalExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

GetAuthenticationMethod(IIdentity)

Gets the authentication method.

public static string GetAuthenticationMethod(this IIdentity identity)

Parameters

identity IIdentity

The identity.

Returns

string

Exceptions

InvalidOperationException

amr claim is missing

GetAuthenticationMethod(IPrincipal)

Gets the authentication method.

public static string GetAuthenticationMethod(this IPrincipal principal)

Parameters

principal IPrincipal

The principal.

Returns

string

GetAuthenticationMethods(IIdentity)

Gets the authentication method claims.

public static IEnumerable<Claim> GetAuthenticationMethods(this IIdentity identity)

Parameters

identity IIdentity

The identity.

Returns

IEnumerable<Claim>

GetAuthenticationMethods(IPrincipal)

Gets the authentication method claims.

public static IEnumerable<Claim> GetAuthenticationMethods(this IPrincipal principal)

Parameters

principal IPrincipal

The principal.

Returns

IEnumerable<Claim>

GetAuthenticationTime(IPrincipal)

Gets the authentication time.

public static DateTime GetAuthenticationTime(this IPrincipal principal)

Parameters

principal IPrincipal

The principal.

Returns

DateTime

GetAuthenticationTimeEpoch(IIdentity)

Gets the authentication epoch time.

public static long GetAuthenticationTimeEpoch(this IIdentity identity)

Parameters

identity IIdentity

The identity.

Returns

long

GetAuthenticationTimeEpoch(IPrincipal)

Gets the authentication epoch time.

public static long GetAuthenticationTimeEpoch(this IPrincipal principal)

Parameters

principal IPrincipal

The principal.

Returns

long

GetDisplayName(ClaimsPrincipal)

Gets the name.

public static string GetDisplayName(this ClaimsPrincipal principal)

Parameters

principal ClaimsPrincipal

The principal.

Returns

string

GetIdentityProvider(IIdentity)

Gets the identity provider.

public static string GetIdentityProvider(this IIdentity identity)

Parameters

identity IIdentity

The identity.

Returns

string

Exceptions

InvalidOperationException

idp claim is missing

GetIdentityProvider(IPrincipal)

Gets the identity provider.

public static string GetIdentityProvider(this IPrincipal principal)

Parameters

principal IPrincipal

The principal.

Returns

string

GetSubjectId(IIdentity)

Gets the subject identifier.

public static string GetSubjectId(this IIdentity identity)

Parameters

identity IIdentity

The identity.

Returns

string

Exceptions

InvalidOperationException

sub claim is missing

GetSubjectId(IPrincipal)

Gets the subject identifier.

public static string GetSubjectId(this IPrincipal principal)

Parameters

principal IPrincipal

The principal.

Returns

string

GetTenant(ClaimsPrincipal)

Gets the tenant.

public static string GetTenant(this ClaimsPrincipal principal)

Parameters

principal ClaimsPrincipal

The principal.

Returns

string

IsAuthenticated(IPrincipal)

Determines whether this instance is authenticated.

public static bool IsAuthenticated(this IPrincipal principal)

Parameters

principal IPrincipal

The principal.

Returns

bool

true if the specified principal is authenticated; otherwise, false.