IAuthDetails

Members

_{Namespace: ASPSecurityKit}
_{Assembly: ASPSecurityKit.dll}

Summary

Provides an interface to represent details related to identity tokens.

Properties

`AuthUrn`

Summary

Gets or sets the identity urn in the format [idTokenType]:[idToken].

Value

The identity urn in the format [idTokenType]:[idToken].

`Secret`

Summary

Gets or sets the secret.

Value

The secret.

`EffectiveFrom`

Summary

Gets or sets the date on which this token becomes effective.

Value

The date on which this token becomes effective.

`ExpiredOn`

Summary

Gets or sets the date on which this token expires.

Value

The date on which this token expires.

`SlidingExpiration`

Summary

Gets or sets a value indicating whether this token supports sliding expiration.

Value

true if this token supports sliding expiration; otherwise, false.

`SlideByDurationInMinutes`

Summary

Gets or sets the duration (in minutes) to slide the expiration by. Applicable if SlidingExpiration is true.

Value

The duration (in minutes) to slide the expiration by.

`KeyBasedAuthAllowed`

Summary

Gets or sets a value indicating whether key based authentication (Service KeyScheme) is allowed on this token.

Value

true if key based authentication (Service KeyScheme) is allowed on this token; otherwise, false.

Remarks

Caution: Service Key scheme is far less secure as it just requires caller to embed the key in the URL to authenticate. There’s no HMAC signature and if someone gets hold of the key (say via MIM), he can spoof the caller comfortably. However, there are valid scenarios in which this scheme becomes necessary and there are ways to minimize the exposure. To learn more visit https://ASPSecurityKit.net/docs/authentication-schemes/#service-key

`RecentAccessWithMFAAt`

Summary

Gets or sets the latest recorded time a request verified with multi-factor was made on this token.

Value

The latest recorded time a request verified with multi-factor was made on this token.

`MFAValidUntilSessionExpired`

Summary

Gets or sets a value indicating whether multi-factor verification is valid for the duration of the associated session.

Value

true if multi-factor verification is valid for the duration of the associated session; otherwise, false.

`MFAEnforced`

Summary

Gets or sets a value indicating whether multi-factor verification is to be enforced on this token.

Value

true if multi-factor verification is to be enforced on this token; otherwise, false.

`KeyType`

Summary

Gets or sets the type of the API key.

Value

The type of the API key.

`FirewallIpRanges`

Summary

Gets or sets the firewall ip ranges.

Value

The firewall ip ranges.

`MFAWhiteListedIpRanges`

Summary

Gets or sets the IP ranges through which the originating requests do not go through MFA at all when using this token. Keep it null/empty so that MFA is not skipped for any traffic.

Value

The white-listed ip ranges through which the originated requests skip MFA checks when using this token.

`OriginDomains`

Summary

Gets or sets the origin domains associated with identity (usually for public keys).

Value

The origin domains associated with identity (usually for public keys).

Methods

`IsMFASupported()`

Summary

Determines whether multi-factor authentication is supported for this token type.

Returns

true if multi-factor authentication is supported for this token type; otherwise, false.

Parameters

This method has no parameters.

`IsMFASupportedAsync()`

Summary

Determines whether multi-factor authentication is supported for this token type.

Returns

true if multi-factor authentication is supported for this token type; otherwise, false.

Parameters

This method has no parameters.

`IsMFASupportedAsync(cancellationToken)`

Summary

Determines whether multi-factor authentication is supported for this token type.

Returns

true if multi-factor authentication is supported for this token type; otherwise, false.

Parameters

Name	Type	Description
cancellationToken	System.Threading.CancellationToken	The cancellation token.