Interface BackchannelAuthenticationHandler
public interface BackchannelAuthenticationHandler
This interface indicates that an authenticator that can fulfill Backchannel authentication requests
-
Method Summary
Modifier and TypeMethodDescriptionvoidcancelAuthenticationRequest(String authReqId) Cancel the backchannel authentication request that is identified by the provided transactioncheckAuthenticationStatus(String authReqId) Get the actual status of a backchannel authentication request by the authenticatorstartAuthentication(String authReqId, BackchannelAuthenticationRequest authRequest) Start backchannel authentication attempt for a given transaction.
-
Method Details
-
startAuthentication
BackchannelStartAuthenticationResult startAuthentication(String authReqId, BackchannelAuthenticationRequest authRequest) Start backchannel authentication attempt for a given transaction.- Parameters:
authReqId- authentication request identifier for which to start authenticationauthRequest- authentication request parameters to authenticate- Returns:
- When success, returns `BackchannelStartAuthenticationResult.ok()`, otherwise the BackchannelStartAuthenticationResult _should_ contain an errorCode that can be looked up as an OAuthError (e.g. `invalid_user_id`, `invalid_binding_message`, `server_error`, etc.)
-
checkAuthenticationStatus
Get the actual status of a backchannel authentication request by the authenticator- Parameters:
authReqId- authentication request identifier to check the state for- Returns:
- the status of the backchannel authentication request, or empty if it was unknown
-
cancelAuthenticationRequest
Cancel the backchannel authentication request that is identified by the provided transaction- Parameters:
authReqId- authentication request identifier that should be cancelled
-