com.microsoft.identity.client

Enum Prompt

java.lang.Object

java.lang.Enum<Prompt>

com.microsoft.identity.client.Prompt

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Prompt>

public enum Prompt
extends java.lang.Enum<Prompt>

The UI options that developer can pass during interactive token acquisition requests.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSENT acquireToken will send prompt=consent to the authorize endpoint.
LOGIN acquireToken will send prompt=login to the authorize endpoint.
SELECT_ACCOUNT acquireToken will send prompt=select_account to the authorize endpoint.
WHEN_REQUIRED acquireToken will not send the prompt parameter to the authorize endpoint.

Method Summary

Modifier and Type	Method and Description
OpenIdConnectPromptParameter	toOpenIdConnectPromptParameter()
java.lang.String	toString()
static Prompt	valueOf(java.lang.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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SELECT_ACCOUNT

public static final Prompt SELECT_ACCOUNT

acquireToken will send prompt=select_account to the authorize endpoint. Shows a list of users from which can be selected for authentication.

LOGIN

public static final Prompt LOGIN

acquireToken will send prompt=login to the authorize endpoint. The user will always be prompted for credentials by the service.

toString override is to enable the correct protocol value of login to be returned instead of "force_login".

CONSENT

public static final Prompt CONSENT

acquireToken will send prompt=consent to the authorize endpoint. The user will be prompted to consent even if consent was granted before.

WHEN_REQUIRED

public static final Prompt WHEN_REQUIRED

acquireToken will not send the prompt parameter to the authorize endpoint. The user may be prompted to login or to consent as required by the request.

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(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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Prompt>

toOpenIdConnectPromptParameter

public OpenIdConnectPromptParameter toOpenIdConnectPromptParameter()