com.microsoft.identity.client

Enum AadAuthorityAudience

java.lang.Object

java.lang.Enum<AadAuthorityAudience>

com.microsoft.identity.client.AadAuthorityAudience

All Implemented Interfaces:

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

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

The audiences that can be used for Authority when making token requests in MSAL.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AzureAdAndPersonalMicrosoftAccount Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant.
AzureAdMultipleOrgs Users with a Microsoft work or school account in any organization’s Azure AD tenant (multi-tenant app).
AzureAdMyOrg Users with a Microsoft work or school account in my organization’s Azure AD tenant (single-tenant app).
PersonalMicrosoftAccount Users with a personal Microsoft account.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AzureAdAndPersonalMicrosoftAccount

public static final AadAuthorityAudience AzureAdAndPersonalMicrosoftAccount

Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant. Maps to https://[instance]/common/.

AzureAdMultipleOrgs

public static final AadAuthorityAudience AzureAdMultipleOrgs

Users with a Microsoft work or school account in any organization’s Azure AD tenant (multi-tenant app). Maps to https://[instance]/organizations/.

PersonalMicrosoftAccount

public static final AadAuthorityAudience PersonalMicrosoftAccount

Users with a personal Microsoft account. Maps to https://[instance]/consumers/.

AzureAdMyOrg

public static final AadAuthorityAudience AzureAdMyOrg

Users with a Microsoft work or school account in my organization’s Azure AD tenant (single-tenant app). Maps to https://[instance]/[tenantId].

Method Detail

values

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

Returns:

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

valueOf

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

getAudienceValue

public java.lang.String getAudienceValue()