APIAuthenticationHandler Class

Represents an authentication handler for API users.

Definition

Namespace: Gemstone.Security.AuthenticationProviders
Assembly: Gemstone.Security (in Gemstone.Security.dll) Version: 1.0.181 -- Release Build+ddfc5abcc226f4dec0986b2a0da5f8a889a81a36

C#View Source Request Example

public class APIAuthenticationHandler : AuthenticationHandler<APIAuthenticationOptions>

VBView Source Request Example

Public Class APIAuthenticationHandler
	Inherits AuthenticationHandler(Of APIAuthenticationOptions)

C++View Source Request Example

public ref class APIAuthenticationHandler : public AuthenticationHandler<APIAuthenticationOptions^>

JavaScriptView Source Request Example

Gemstone.Security.AuthenticationProviders.APIAuthenticationHandler = function();

Type.createClass(
	'Gemstone.Security.AuthenticationProviders.APIAuthenticationHandler',
	Microsoft.AspNetCore.Authentication.AuthenticationHandler`1);

Inheritance: Object AuthenticationHandlerAPIAuthenticationOptions APIAuthenticationHandler

Constructors

APIAuthenticationHandler

Represents an authentication handler for API users.

Properties

ClaimsIssuer	Gets the issuer that should be used when any claims are issued. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
Clock	Gets the ISystemClock. (Inherited from AuthenticationHandlerAPIAuthenticationOptions) Obsolete
Context	Gets or sets the HttpContext. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
CurrentUri	Gets the absolute current url. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
Events	The handler calls methods on the events which give the application control at certain points where processing is occurring. If it is not provided a default instance is supplied which does nothing when the methods are called. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
Logger	Gets the ILogger. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
Options	Gets or sets the options associated with this authentication handler. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
OptionsMonitor	Gets the IOptionsMonitorTOptions to detect changes to options. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
OriginalPath	Gets the path as seen by the authentication middleware. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
OriginalPathBase	Gets the path base as seen by the authentication middleware. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
Request	Gets the HttpRequest associated with the current request. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
Response	Gets the HttpResponse associated with the current request. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
Scheme	Gets or sets the AuthenticationScheme associated with this authentication handler. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
TimeProvider	Gets the current time, primarily for unit testing. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
UrlEncoder	Gets the UrlEncoder. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)

Methods

AuthenticateAsync	(Inherited from AuthenticationHandlerAPIAuthenticationOptions)
BuildRedirectUri	Constructs an absolute url for the specified targetPath. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
ChallengeAsync	(Inherited from AuthenticationHandlerAPIAuthenticationOptions)
CreateEventsAsync	Creates a new instance of the events instance. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
ForbidAsync	(Inherited from AuthenticationHandlerAPIAuthenticationOptions)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
HandleAuthenticateAsync	Parses the Authorization header and API token. (Overrides AuthenticationHandlerTOptionsHandleAuthenticateAsync)
HandleAuthenticateOnceAsync	Used to ensure HandleAuthenticateAsync is only invoked once. The subsequent calls will return the same authenticate result. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
HandleAuthenticateOnceSafeAsync	Used to ensure HandleAuthenticateAsync is only invoked once safely. The subsequent calls will return the same authentication result. Any exceptions will be converted into a failed authentication result containing the exception. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
HandleChallengeAsync	Returns a 401 Unauthorized response with the WWW-Authenticate header. (Overrides AuthenticationHandlerTOptionsHandleChallengeAsync(AuthenticationProperties))
HandleForbiddenAsync	Override this method to handle Forbid. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
InitializeAsync	Initialize the handler, resolve the options and validate them. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
InitializeEventsAsync	Initializes the events object, called once per request by InitializeAsync(AuthenticationScheme, HttpContext). (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
InitializeHandlerAsync	Called after options/events have been initialized for the handler to finish initializing itself. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
ResolveTarget	Resolves the scheme that this authentication operation is forwarded to. (Inherited from AuthenticationHandlerAPIAuthenticationOptions)
ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

AuthenticationType

Authentication type used for API authentication.