Enum AuthenticationStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AuthenticationStatus>

    public enum AuthenticationStatus
    extends java.lang.Enum<AuthenticationStatus>
    From: https://developer.okta.com/docs/api/resources/authn#transaction-state
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LOCKED_OUT
      The user account is locked; self-service unlock or admin unlock is required.
      MFA_CHALLENGE
      The user must verify the factor-specific challenge.
      MFA_ENROLL
      The user must select and enroll an available factor for additional verification.
      MFA_ENROLL_ACTIVATE
      The user must activate the factor to complete enrollment.
      MFA_REQUIRED
      The user must provide additional verification with a previously enrolled factor.
      PASSWORD_EXPIRED
      The user’s password was successfully validated but is expired.
      PASSWORD_RESET
      The user successfully answered their recovery question and must to set a new password.
      PASSWORD_WARN
      The user’s password was successfully validated but is about to expire and should be changed.
      RECOVERY
      The user has requested a recovery token to reset their password or unlock their account.
      RECOVERY_CHALLENGE
      The user must verify the factor-specific recovery challenge.
      SUCCESS
      The transaction has completed successfully.
      UNAUTHENTICATED
      User tried to access protected resource (ex: an app) but user is not authenticated
      UNKNOWN
      Other state NOT directly supported by this implementation.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static AuthenticationStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AuthenticationStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • UNAUTHENTICATED

        public static final AuthenticationStatus UNAUTHENTICATED
        User tried to access protected resource (ex: an app) but user is not authenticated
      • PASSWORD_WARN

        public static final AuthenticationStatus PASSWORD_WARN
        The user’s password was successfully validated but is about to expire and should be changed.
      • PASSWORD_EXPIRED

        public static final AuthenticationStatus PASSWORD_EXPIRED
        The user’s password was successfully validated but is expired.
      • RECOVERY

        public static final AuthenticationStatus RECOVERY
        The user has requested a recovery token to reset their password or unlock their account.
      • RECOVERY_CHALLENGE

        public static final AuthenticationStatus RECOVERY_CHALLENGE
        The user must verify the factor-specific recovery challenge.
      • PASSWORD_RESET

        public static final AuthenticationStatus PASSWORD_RESET
        The user successfully answered their recovery question and must to set a new password.
      • LOCKED_OUT

        public static final AuthenticationStatus LOCKED_OUT
        The user account is locked; self-service unlock or admin unlock is required.
      • MFA_ENROLL

        public static final AuthenticationStatus MFA_ENROLL
        The user must select and enroll an available factor for additional verification.
      • MFA_ENROLL_ACTIVATE

        public static final AuthenticationStatus MFA_ENROLL_ACTIVATE
        The user must activate the factor to complete enrollment.
      • MFA_REQUIRED

        public static final AuthenticationStatus MFA_REQUIRED
        The user must provide additional verification with a previously enrolled factor.
      • MFA_CHALLENGE

        public static final AuthenticationStatus MFA_CHALLENGE
        The user must verify the factor-specific challenge.
      • SUCCESS

        public static final AuthenticationStatus SUCCESS
        The transaction has completed successfully.
      • UNKNOWN

        public static final AuthenticationStatus UNKNOWN
        Other state NOT directly supported by this implementation.
    • Method Detail

      • values

        public static AuthenticationStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (AuthenticationStatus c : AuthenticationStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AuthenticationStatus valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null