Change type of `idTokenClaims` for direct access

Core Library

MSAL.js v2 (@azure/msal-browser)

Wrapper Library

MSAL Angular (@azure/msal-angular)

Description

If the idTokenClaims are set on an account, it’s recognized as an object. This means you cannot access it’s members (roles doesn't exist on object). With the following work-around I’m able to access the properties in the identity token.

// Doesn't work
const roles = account.idTokenClaims.roles;
// or
const roles2 = account.idTokenClaims['roles'];
// this does work
const claims = account.idTokenClaims as { [key: string]: any };
const roles3 = claims.roles;
// and this does also work:
const roles4 = claims['roles'];

The type { [key: string]: any } is valid for each json document, and since the idTokenClaims are always represented as json, this would be a better description, and allow access to all the claims without manually changing the type. It would also support future claims that are not known yet.

An alternative would be to create something like this, but that requires more maintenance:

declare type IdentityToken {
  aud?: string;
  exp?: number;
  iss?: string;
  name?: string;
  roles?: string[];
}

// Or supporting both methods
declare type IdentityTokenExtension  = IdentityToken & {  [key: string]: any; }

Source

External (Customer)

[msftbot[bot]]

🎉This issue was addressed in #4680, which has now been successfully released as @azure/msal-common@v6.3.0.🎉

We recommend upgrading to the latest version of @azure/msal-browser or @azure/msal-node to take advantage of this change.

Handy links:

• Release Notes
• Official NPM Release

[svrooij]

@sameerag all tests are checked in the PR and are still green