com.microsoft.identity.client

Interface IClaimable

All Known Subinterfaces:

IAccount, IMultiTenantAccount, ITenantProfile

All Known Implementing Classes:

Account, MultiTenantAccount, TenantProfile

public interface IClaimable

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,?>	getClaims() Gets the claims associated with this IClaimable's IdToken.
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.

Method Detail

getIdToken

java.lang.String getIdToken()

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.

Returns:

The raw id_token.

getClaims

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

Gets the claims associated with this IClaimable's IdToken.

Returns:

A Map of claims.

getUsername

java.lang.String getUsername()

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.

Returns:

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

getTenantId

java.lang.String getTenantId()

Gets the tid claim associated with this IClaimable.

Returns:

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