Paiwise.IRemoteAuthentication Interface Reference

Interface for remote authentications. More...

Inherited by Waher.Service.IoTBroker.Legal.MFA.QuickLoginRemoteAuthentication.

Public Member Functions
Task< bool >	IsValidAddress ()
	Checks if the remote address is valid. More...
Task< bool >	IsLegalIdAvailable ()
	Checks if a Legal Id is available for the remote ID. More...
Task< bool >	IsPermitted (IUser User)
	Checks is the remote address is permitted to perform the requested operation. More...
Task< Uri >	GetChallengeUri (string Purpose, string RemoteEndPoint)
	Gets a Challenge URI to send to the requestor of the remote authentication. More...
Task< string >	Start (string Purpose, string RemoteEndPoint, EventHandlerAsync< RemoteAuthenticationEventArgs > Callback, object State)
	Starts the remote authentication process. More...

Properties
string	Key [get]
	Key identifying the remote authentication. More...

Detailed Description

Interface for remote authentications.

Definition at line 11 of file IRemoteAuthentication.cs.

Member Function Documentation

GetChallengeUri()

Task< Uri > Paiwise.IRemoteAuthentication.GetChallengeUri	(	string	Purpose,
		string	RemoteEndPoint
	)

Gets a Challenge URI to send to the requestor of the remote authentication.

Parameters

Purpose	Purpose message to send to the remote party being authenticated.
RemoteEndPoint	Remote EndPoint of the requestor of the remote authentication.

Returns

URI, if challenge URI is used, or null otherwise.

A Challenge URI can be a URI to a QR code, for instance.

IsLegalIdAvailable()

Task< bool > Paiwise.IRemoteAuthentication.IsLegalIdAvailable

(

)

Checks if a Legal Id is available for the remote ID.

Returns

If available.

IsPermitted()

Task< bool > Paiwise.IRemoteAuthentication.IsPermitted

(

IUser

User

)

Checks is the remote address is permitted to perform the requested operation.

Parameters

User	User performing the remote authentication.

Returns

If permitted.

IsValidAddress()

Task< bool > Paiwise.IRemoteAuthentication.IsValidAddress

(

)

Checks if the remote address is valid.

Returns

If valid.

Start()

Task< string > Paiwise.IRemoteAuthentication.Start	(	string	Purpose,
		string	RemoteEndPoint,
		EventHandlerAsync< RemoteAuthenticationEventArgs >	Callback,
		object	State
	)

Starts the remote authentication process.

Parameters

Purpose	Purpose message to send to the remote party being authenticated.
RemoteEndPoint	Remote EndPoint of the requestor of the remote authentication.
Callback	Method to call when remote authentication is completed.
State	State object to pass on to callback method.

Returns

String Identifier of remote authentication process.

Property Documentation

Key

string Paiwise.IRemoteAuthentication.Key

get

Key identifying the remote authentication.

Definition at line 16 of file IRemoteAuthentication.cs.

---

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

• C:/My Projects/IoTBroker/Waher.Payments/IRemoteAuthentication.cs