Package com.inductiveautomation.perspective.gateway.api

Interface AuthChallengeCompleteEvent

  • public interface AuthChallengeCompleteEvent
    This event is fired when an authentication challenge is completed by the user. It is passed to the onAuthChallengeCompleted session event script handler if the authentication challenge originated from the authentication challenge action or the system.perspective.authenticationChallenge scripting function. It is fired on the session event bus if the authentication challenge originated from any other source, such as a third party module.

    • Method Detail

      • getClient

        java.lang.String getClient()
        Returns:
        the auth challenge client identifier associated with the client which triggered the auth challenge

      • getPayload

        java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonElement> getPayload()
        Returns:
        an Optional containing the opaque payload set on the auth challenge request, or an empty Optional if a null payload was set