Type alias IdTokenClaims

IdTokenClaims: {
    acr?: string;
    amr?: string[];
    at?: string;
    aud?: string;
    auth_time?: number;
    cloud_instance_host_name?: string;
    cnf?: {
        kid: string;
    };
    emails?: string[];
    exp?: number;
    home_oid?: string;
    iat?: number;
    idp?: string;
    iss?: string;
    login_hint?: string;
    m?: string;
    name?: string;
    nbf?: number;
    nonce?: string;
    oid?: string;
    p?: string;
    preferred_username?: string;
    roles?: string[];
    sid?: string;
    sub?: string;
    tenant_region_scope?: string;
    tenant_region_sub_scope?: string;
    tfp?: string;
    tid?: string;
    ts?: number;
    u?: string;
    upn?: string;
    ver?: string;
    x5c_ca?: string[];
}

Type which describes Id Token claims known by MSAL.

Type declaration

  • Optional acr?: string

    Authentication Context Class Reference (B2C) Used only with older policies.

  • Optional amr?: string[]
  • Optional at?: string
  • Optional aud?: string

    Audience

  • Optional auth_time?: number
  • Optional cloud_instance_host_name?: string
  • Optional cnf?: {
        kid: string;
    }
    • kid: string
  • Optional emails?: string[]
  • Optional exp?: number

    Expiration

  • Optional home_oid?: string
  • Optional iat?: number

    Issued at

  • Optional idp?: string
  • Optional iss?: string

    Issuer

  • Optional login_hint?: string
  • Optional m?: string
  • Optional name?: string
  • Optional nbf?: number

    Not valid before

  • Optional nonce?: string
  • Optional oid?: string

    Immutable object identifier, this ID uniquely identifies the user across applications

  • Optional p?: string
  • Optional preferred_username?: string
  • Optional roles?: string[]
  • Optional sid?: string
  • Optional sub?: string

    Immutable subject identifier, this is a pairwise identifier - it is unique to a particular application ID

  • Optional tenant_region_scope?: string

    Region of the resource tenant

  • Optional tenant_region_sub_scope?: string
  • Optional tfp?: string

    Trusted Framework Policy (B2C) The name of the policy that was used to acquire the ID token.

  • Optional tid?: string

    Users' tenant or '9188040d-6c67-4c5b-b112-36a304b66dad' for personal accounts.

  • Optional ts?: number
  • Optional u?: string
  • Optional upn?: string
  • Optional ver?: string
  • Optional x5c_ca?: string[]

Generated using TypeDoc