public interface OOBAuthPlugin extends Plugin
Plugin
, which provides a plugin the ability
to describes itself to the PingFederate server and be configured based on that description.Modifier and Type | Method and Description |
---|---|
OOBAuthResultContext |
check(String transactionIdentifier,
Map<String,Object> inParameters)
Checks the status of a transaction previously started via
initiate(OOBAuthRequestContext, Map) . |
void |
finished(String transactionIdentifier)
Gives an opportunity to clean up state associated with the transaction.
|
OOBAuthTransactionContext |
initiate(OOBAuthRequestContext requestContext,
Map<String,Object> inParameters)
Starts an out-of-band authentication/authorization with an end-user identified via the user attributes
in the OOBAuthRequestContext provided in the call.
|
configure
getPluginDescriptor
OOBAuthTransactionContext initiate(OOBAuthRequestContext requestContext, Map<String,Object> inParameters) throws UnknownUserException, UserAuthBindingMessageException, OOBAuthGeneralException
requestContext
- information about the out-of-band authentication/authorization request including
attributes that identify the user, the requested scope of authorization, and moreinParameters
- A map that contains a set of additional input parameters. When used in a CIBA context,
which is currently the only usage, there will be only one entry with a key
"ciba.auth_req_id" and value of the CIBA auth_req_id.UnknownUserException
- if the end-user cannot be identifiedUserAuthBindingMessageException
- if the user authorization binding message is invalidOOBAuthGeneralException
- for unexpected issues, typically wrapping an implementation specific exception typeOOBAuthResultContext check(String transactionIdentifier, Map<String,Object> inParameters) throws OOBAuthGeneralException
initiate(OOBAuthRequestContext, Map)
.transactionIdentifier
- the unique identifier for out-of-band authentication/authorization transaction
given by the OOBAuthTransactionContext returned from
initiate(OOBAuthRequestContext, Map)
inParameters
- A map that contains a set of additional input parameters. When used in a CIBA context,
which is currently the only usage, there will be only one entry with a key
"ciba.auth_req_id" and value of the CIBA auth_req_id.OOBAuthGeneralException
- for unexpected issues, typically wrapping an implementation specific exception typevoid finished(String transactionIdentifier) throws OOBAuthGeneralException
transactionIdentifier
- the unique identifier for out-of-band authentication/authorization transaction
given by the OOBAuthTransactionContext returned from
initiate(OOBAuthRequestContext, Map)
OOBAuthGeneralException
- for unexpected issues, typically wrapping an implementation specific exception typeCopyright 2019 Ping Identity Corp. All rights reserved.