Type alias AuthenticationResult

AuthenticationResult: {
    accessToken: string;
    account: AccountInfo | null;
    authority: string;
    cloudGraphHostName?: string;
    code?: string;
    correlationId: string;
    expiresOn: Date | null;
    extExpiresOn?: Date;
    familyId?: string;
    fromCache: boolean;
    fromNativeBroker?: boolean;
    idToken: string;
    idTokenClaims: object;
    msGraphHost?: string;
    refreshOn?: Date;
    requestId?: string;
    scopes: string[];
    state?: string;
    tenantId: string;
    tokenType: string;
    uniqueId: string;
}

Result returned from the authority's token endpoint.

  • uniqueId - oid or sub claim from ID token
  • tenantId - tid claim from ID token
  • scopes - Scopes that are validated for the respective token
  • account - An account object representation of the currently signed-in user
  • idToken - Id token received as part of the response
  • idTokenClaims - MSAL-relevant ID token claims
  • accessToken - Access token or SSH certificate received as part of the response
  • fromCache - Boolean denoting whether token came from cache
  • expiresOn - Javascript Date object representing relative expiration of access token
  • extExpiresOn - Javascript Date object representing extended relative expiration of access token in case of server outage
  • refreshOn - Javascript Date object representing relative time until an access token must be refreshed
  • state - Value passed in by user in request
  • familyId - Family ID identifier, usually only used for refresh tokens
  • requestId - Request ID returned as part of the response

Type declaration

  • accessToken: string
  • account: AccountInfo | null
  • authority: string
  • Optional cloudGraphHostName?: string
  • Optional code?: string
  • correlationId: string
  • expiresOn: Date | null
  • Optional extExpiresOn?: Date
  • Optional familyId?: string
  • fromCache: boolean
  • Optional fromNativeBroker?: boolean
  • idToken: string
  • idTokenClaims: object
  • Optional msGraphHost?: string
  • Optional refreshOn?: Date
  • Optional requestId?: string
  • scopes: string[]
  • Optional state?: string
  • tenantId: string
  • tokenType: string
  • uniqueId: string

Settings

Member Visibility

Theme

Generated using TypeDoc