com.microsoft.identity.client

Class Account

java.lang.Object

com.microsoft.identity.client.Account

All Implemented Interfaces:

IAccount, IClaimable, java.io.Serializable

Direct Known Subclasses:

MultiTenantAccount, TenantProfile

public class Account
extends java.lang.Object
implements IAccount

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Account(java.lang.String clientInfo, IDToken homeTenantIdToken)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthority()
java.util.Map<java.lang.String,?>	getClaims() Gets the claims associated to this Account's IdToken.
java.lang.String	getId() Gets the id of the account.
java.lang.String	getIdToken() Gets the JWT format id_token corresponding to this IClaimable.
java.lang.String	getTenantId() Gets the tid claim associated with this IClaimable.
java.lang.String	getUsername() Gets the preferred_username claim associated with this IClaimable.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Account

public Account(java.lang.String clientInfo,
               IDToken homeTenantIdToken)

Method Detail

getId

public java.lang.String getId()

Description copied from interface: IAccount

Gets the id of the account.

For the Microsoft Identity Platform: the OID of the account in its home tenant.

Specified by:

getId in interface IAccount

Returns:

The id.

getTenantId

public java.lang.String getTenantId()

Description copied from interface: IClaimable

Gets the tid claim associated with this IClaimable.

Specified by:

getTenantId in interface IClaimable

Returns:

The tid claim or "" (empty string) if not available.

getIdToken

public java.lang.String getIdToken()

Description copied from interface: IClaimable

Gets the JWT format id_token corresponding to this IClaimable. This value conforms to RFC-7519 and is further specified according to OpenID Connect Core.

Note: MSAL does not validate the JWT token.

Specified by:

getIdToken in interface IClaimable

Returns:

The raw id_token.

getClaims

public java.util.Map<java.lang.String,?> getClaims()

Gets the claims associated to this Account's IdToken. In the case of the Microsoft Identity Platform, this value can be null if the home tenant has not been authorized.

Specified by:

getClaims in interface IClaimable

Returns:

The claims for this Account's IdToken or null, if no IdToken exists.

getUsername

public java.lang.String getUsername()

Description copied from interface: IClaimable

Gets the preferred_username claim associated with this IClaimable.

Note: On the Microsoft B2C Identity Platform, this claim may be unavailable when external identity providers are used.

Specified by:

getUsername in interface IClaimable

Returns:

The preferred_username claim or "" (empty string) if not available.

getAuthority

public java.lang.String getAuthority()

Specified by:

getAuthority in interface IAccount