Interface BackchannelAuthenticationHandler


public interface BackchannelAuthenticationHandler
This interface indicates that an authenticator that can fulfill Backchannel authentication requests
  • Method Details

    • startAuthentication

      Start backchannel authentication attempt for a given transaction.
      Parameters:
      authReqId - authentication request identifier for which to start authentication
      authRequest - 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

      Optional<BackchannelAuthenticationResult> checkAuthenticationStatus(String authReqId)
      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

      void cancelAuthenticationRequest(String authReqId)
      Cancel the backchannel authentication request that is identified by the provided transaction
      Parameters:
      authReqId - authentication request identifier that should be cancelled