Package com.pingidentity.sdk.oobauth

A plugin interface, with associated classes, for orchestrating out-of-band authentication/authorization.

Since:

9.3

Interface Summary

Interface	Description
OOBAuthPlugin	This interface defines the methods that the PingFederate server calls to orchestrate out-of-band authentication/authorization.

Class Summary

Class	Description
OOBAuthRequestContext	Information about an out-of-band authentication/authorization request, which is passed to OOBAuthPlugin.initiate(OOBAuthRequestContext, Map) to begin the transaction.
OOBAuthRequestContext.RequestingApplication	Some general information about the calling application or client.
OOBAuthResultContext	Information about the state of an out-of-band authentication/authorization transaction returned from OOBAuthPlugin.check(String, Map).
OOBAuthStatusChangeReceiver	A class which accepts status change notifications from OOBAuthPlugin implementations.
OOBAuthTransactionContext	Information about an out-of-band authentication/authorization transaction returned from OOBAuthPlugin.initiate(OOBAuthRequestContext, Map).

Enum Summary

Enum	Description
OOBAuthResultContext.Status

Exception Summary

Exception	Description
OOBAuthGeneralException	A general exception for unexpected issues encountered in implementations of OOBAuthPlugin, typically wrapping an implementation specific exception type.
UnknownUserException	An exception that can be thrown from OOBAuthPlugin.initiate(OOBAuthRequestContext, Map) to indicate that the end-user cannot be identified or doesn't exist.
UserAuthBindingMessageException	An exception that can be thrown from OOBAuthPlugin.initiate(OOBAuthRequestContext, Map) to indicate that the user authorization binding message is invalid.