PushTechnology.ClientInterface.Client.Security.Authentication.IAuthenticationHandlerCallback Interface Reference

Single-use callback provided to authenticate. More...

Inherited by PushTechnology.ClientInterface.Client.Security.Authentication.CompositeAuthenticationHandler.Callback.

Public Member Functions
void	Allow ()
	Authentication passed - allow the authentication request. More...
void	Allow (IAuthenticationResult result)
	Authentication passed - allow the authentication request with additional information provided relating to the session (e.g. additional security roles). More...
void	Abstain ()
	The authentication has neither passed nor failed. More...
void	Deny ()
	Authentication failed - deny the authentication request. More...

Detailed Description

Single-use callback provided to authenticate.

The server calls the handlers for each authentication request. Each handler must respond "allow", "abstain", or "deny".

Authentication handlers are configured in precedence order. Authentication will succeed if a handler returns "allow" and all higher precedence handlers (earlier in the order) return "abstain". Authentication will fail if a handler returns "deny" and all higher precedence handlers return "abstain". If all authentication handlers return "abstain", the request will be denied. Once the outcome is known, the server may choose not to call the remaining handlers.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Security.Authentication.IAuthenticationHandlerCallback.Abstain

(

)

The authentication has neither passed nor failed.

void PushTechnology.ClientInterface.Client.Security.Authentication.IAuthenticationHandlerCallback.Allow

(

)

Authentication passed - allow the authentication request.

void PushTechnology.ClientInterface.Client.Security.Authentication.IAuthenticationHandlerCallback.Allow

(

IAuthenticationResult

result

)

Authentication passed - allow the authentication request with additional information provided relating to the session (e.g. additional security roles).

Parameters

result

Additional information for the session.

void PushTechnology.ClientInterface.Client.Security.Authentication.IAuthenticationHandlerCallback.Deny

(

)

Authentication failed - deny the authentication request.

---

The documentation for this interface was generated from the following file:

• LegacyModule/Client/Security/Authentication/IAuthenticationHandlerCallback.cs