Package com.pingidentity.sdk.oobauth

Class OOBAuthResultContext

  • public class OOBAuthResultContext
extends Object
    Information about the state of an out-of-band authentication/authorization transaction returned from OOBAuthPlugin.check(String, Map).
    Since:
    9.3

    • Constructor Detail

      • OOBAuthResultContext

        public OOBAuthResultContext()

    • Method Detail

      • getStatus

        public OOBAuthResultContext.Status getStatus()
        Gets the status of the given out-of-band authentication/authorization transaction.
        Returns:
        the status

      • setStatus

        public void setStatus​(OOBAuthResultContext.Status status)
        Sets the status of the given out-of-band authentication/authorization transaction.
        Parameters:
        status - the status

      • getStatusMessage

        public String getStatusMessage()
        Gets a status message, which will be propagated in the protocol response (if applicable to the outer protocol).
        Returns:
        the message

      • setStatusMessage

        public void setStatusMessage​(String statusMessage)
        Sets a status message, which will be propagated in the protocol response (if applicable to the outer protocol).
        Parameters:
        statusMessage - the message

      • getApprovedScope

        public Set<String> getApprovedScope()
        Gets the approved scope as a set of scope value strings. If the approved scope is the same as the requested scope, this can be null.
        Returns:
        the approved scope as a set of scope value strings or null if the approved scope is the same as the requested scope

      • setApprovedScope

        public void setApprovedScope​(Set<String> approvedScope)
        Sets the approved scope as a set of scope value strings.
        Parameters:
        approvedScope - the approved scope as a set of scope value strings or null if the approved scope is the same as the requested scope

      • getApprovedAuthorizationDetails

        public AuthorizationDetails getApprovedAuthorizationDetails()
        Gets the approved authorization details. If the approved authorization details are the same as the requested authorization details, this can be null.
        Returns:
        the approved authorization detail as a JSON array string or null if the approved authorization details is the same as the requested authorization details.

      • setApprovedAuthorizationDetails

        public void setApprovedAuthorizationDetails​(AuthorizationDetails approvedAuthorizationDetails)
        Sets the approved authorization details.
        Parameters:
        approvedAuthorizationDetails - the approved authorization details as a JSON array string or null if the approved authorization details is the same as the requested authorization details.