Package com.pingidentity.sdk.oobauth

Class OOBAuthRequestContext

    • Constructor Detail

      • OOBAuthRequestContext

        public OOBAuthRequestContext()

    • Method Detail

      • getUserAttributes

        public AttributeMap getUserAttributes()
        Gets the attributes that identify the user (and potentially other context about the user) from whom out-of-band authentication/authorization is being requested.
        Returns:
        the AttributeMap with the attribute contract attributes of the given OOBAuthPlugin instance

      • setUserAttributes

        public void setUserAttributes​(AttributeMap userAttributes)
        Sets the attributes.
        Parameters:
        userAttributes - the attributes.

      • getRequestedScope

        public Map<String,​String> getRequestedScope()
        Gets the scope of access requested.
        Returns:
        A Map with the requested scope. The keys of the map are scope value strings and the entries are localized human readable descriptions.

      • setRequestedScope

        public void setRequestedScope​(Map<String,​String> requestedScope)
        Sets the requested scope.
        Parameters:
        requestedScope - the requested scope map

      • getUserAuthBindingMessage

        public String getUserAuthBindingMessage()
        Gets the user authorization binding message, if one was sent by the calling application or client. The binding message is intended to be displayed on both the consumption device and the authentication device to interlock them together for the transaction by way of a visual cue for the end-user. This interlocking message enables the end-user to ensure that the action taken on the authentication device is related to the request initiated by the consumption device. The value should typically contain something that enables the end-user to reliably discern that the transaction is related across the consumption device and the authentication device, such as a random value of reasonable entropy (e.g. a transactional approval code).
        Returns:
        the user authorization binding message, if sent by the calling application/client. Null otherwise.

      • setUserAuthBindingMessage

        public void setUserAuthBindingMessage​(String userAuthBindingMessage)
        Sets the user authorization binding message.
        Parameters:
        userAuthBindingMessage - the message

      • getRequestingApplication

        public OOBAuthRequestContext.RequestingApplication getRequestingApplication()
        Gets some information about the the calling application or client.
        Returns:
        a RequestingApplication object with some general information about the calling application or client

      • setRequestingApplication

        public void setRequestingApplication​(OOBAuthRequestContext.RequestingApplication requestingApplication)
        Sets information about the the calling application or client.
        Parameters:
        requestingApplication - a RequestingApplication object with some general information about the calling application or client

      • getLocale

        public Locale getLocale()
        Gets the locale to use for presenting content to the user.
        Returns:
        the locale

      • setLocale

        public void setLocale​(Locale locale)
        Sets the locale
        Parameters:
        locale - the locale

      • getRequestedAuthorizationDetails

        public Map<AuthorizationDetail,​String> getRequestedAuthorizationDetails()
        Gets the authorization details of access requested.
        Returns:
        A Map with the requested authorization details. The keys of the map are AuthorizationDetail and the entries are localized human readable descriptions.

      • setRequestedAuthorizationDetails

        public void setRequestedAuthorizationDetails​(Map<AuthorizationDetail,​String> requestedAuthorizationDetails)
        Sets the requested authorization details.
        Parameters:
        requestedAuthorizationDetails - the requested authorization details map