com.microsoft.aad.msal4j

Enum Prompt

java.lang.Object

java.lang.Enum<Prompt>

com.microsoft.aad.msal4j.Prompt

All Implemented Interfaces:

Serializable, Comparable<Prompt>

public enum Prompt
extends Enum<Prompt>

Indicate the type of user interaction that is required when sending authorization code request.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN_CONSENT An administrator should be prompted to consent on behalf of all users in their organization.
ADMING_CONSENT Deprecated.
CONSENT User consent has been granted, but needs to be updated.
LOGIN The user should be prompted to reauthenticate.
NONE User will not be shown an interactive prompt
SELECT_ACCOUNT The user is prompted to select an account, interrupting single sign on.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOGIN

public static final Prompt LOGIN

The user should be prompted to reauthenticate.

SELECT_ACCOUNT

public static final Prompt SELECT_ACCOUNT

The user is prompted to select an account, interrupting single sign on. The user may select an existing signed-in account, enter their credentials for a remembered account, or choose to use a different account altogether.

CONSENT

public static final Prompt CONSENT

User consent has been granted, but needs to be updated. The user should be prompted to consent.

ADMING_CONSENT

@Deprecated
public static final Prompt ADMING_CONSENT

Deprecated.

An administrator should be prompted to consent on behalf of all users in their organization.

Deprecated, instead use Prompt.ADMIN_CONSENT

ADMIN_CONSENT

public static final Prompt ADMIN_CONSENT

An administrator should be prompted to consent on behalf of all users in their organization.

NONE

public static final Prompt NONE

User will not be shown an interactive prompt

Method Detail

values

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

Returns:

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

valueOf

public static Prompt 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

toString

public String toString()

Overrides:

toString in class Enum<Prompt>