Package com.okta.idx.sdk.api.response

Class IDXResponse

java.lang.Object
com.okta.idx.sdk.api.response.IDXResponse
public class IDXResponse extends Object

  • Constructor Details

    • IDXResponse

      public IDXResponse()

  • Method Details

    • remediation

      public Remediation remediation()
      Return the current remediation object. MAY be null if there are no further remediation steps necessary
      Returns:
      Remediation|null

    • cancel

      public IDXResponse cancel(IDXClient client) throws ProcessingException
      The method to call when you want to cancel the Okta Identity Engine flow. This will return an IDXResponse
      Parameters:
      client - the IDXClient instance
      Returns:
      IDXResponse
      Throws:
      ProcessingException - when the cancel operation encountered an execution/processing error.

    • successWithInteractionCode

      public SuccessResponse successWithInteractionCode()
      Return a success response object after `loginSuccess()` returns true.
      Returns:
      SuccessResponse

    • isLoginSuccessful

      public boolean isLoginSuccessful()
      Check for the status of `successWithInteractionCode` indicating if the login was successful.
      Returns:
      boolean

    • raw

      public String raw() throws com.fasterxml.jackson.core.JsonProcessingException
      Returns the raw JSON body of the Okta Identity Engine response.
      Returns:
      String
      Throws:
      com.fasterxml.jackson.core.JsonProcessingException - json processing exception

    • getStateHandle

      public String getStateHandle()

    • getMessages

      public Messages getMessages()

    • getAuthenticatorEnrollments

      public AuthenticatorEnrollments getAuthenticatorEnrollments()

    • getUser

      public User getUser()

    • getAuthenticators

      public Authenticators getAuthenticators()

    • getCurrentAuthenticatorEnrollment

      public CurrentAuthenticatorEnrollment getCurrentAuthenticatorEnrollment()

    • getCurrentAuthenticator

      public CurrentAuthenticatorEnrollment getCurrentAuthenticator()

    • getSuccessWithInteractionCode

      public SuccessResponse getSuccessWithInteractionCode()