com.microsoft.aad.msal4j

Enum InteractionRequiredExceptionReason

java.lang.Object

java.lang.Enum<InteractionRequiredExceptionReason>

com.microsoft.aad.msal4j.InteractionRequiredExceptionReason

All Implemented Interfaces:

Serializable, Comparable<InteractionRequiredExceptionReason>

public enum InteractionRequiredExceptionReason
extends Enum<InteractionRequiredExceptionReason>

Details about the cause of an MsalInteractionRequiredException, giving a hint about the user can expect when they go through interactive authentication

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDITIONAL_ACTION Issue can be resolved by remedial interaction with the system, outside of the interactive authentication flow.
BASIC_ACTION Issue can be resolved by user interaction during the interactive authentication flow.
CONSENT_REQUIRED User consent is missing, or has been revoked.
MESSAGE_ONLY Issue cannot be resolved at this time.
NONE No further details are provided.
USER_PASSWORD_EXPIRED User's password has expired.

Method Summary

Modifier and Type	Method and Description
static InteractionRequiredExceptionReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static InteractionRequiredExceptionReason[]	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

NONE

public static final InteractionRequiredExceptionReason NONE

No further details are provided. It is possible that the user will be able to resolve the issue by launching interactive authentication

MESSAGE_ONLY

public static final InteractionRequiredExceptionReason MESSAGE_ONLY

Issue cannot be resolved at this time. Launching interactive authentication flow will show a message explaining the condition

BASIC_ACTION

public static final InteractionRequiredExceptionReason BASIC_ACTION

Issue can be resolved by user interaction during the interactive authentication flow.

ADDITIONAL_ACTION

public static final InteractionRequiredExceptionReason ADDITIONAL_ACTION

Issue can be resolved by remedial interaction with the system, outside of the interactive authentication flow. Starting an interactive authentication flow will show the user what they need to to do, but it is possible that the user is unable to complete the action

CONSENT_REQUIRED

public static final InteractionRequiredExceptionReason CONSENT_REQUIRED

User consent is missing, or has been revoked. Issue can be resolved by user consenting during the interactive authentication flow

USER_PASSWORD_EXPIRED

public static final InteractionRequiredExceptionReason USER_PASSWORD_EXPIRED

User's password has expired. Issue can be resolved by user during the interactive authentication flow

Method Detail

values

public static InteractionRequiredExceptionReason[] 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 (InteractionRequiredExceptionReason c : InteractionRequiredExceptionReason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InteractionRequiredExceptionReason valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null