IClaimable Interface

Package:

com.microsoft.identity.client

public interface IClaimable

Method Summary

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

Method Details

getClaims

public Map getClaims()

Gets the claims associated with this IClaimable's IdToken.

Returns:

A Map of claims.

getIdToken

public 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.

getTenantId

public String getTenantId()

Gets the tid claim associated with this IClaimable.

Returns:

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

getUsername

public 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.