Type aliases
AccountInfo
Account
Info: { environment: string; homeAccountId: string; idTokenClaims?: TokenClaims & {}; localAccountId: string; name?: string; nativeAccountId?: string; tenantId: string; username: string }
Type declaration
-
environment: string
-
homeAccountId: string
-
Optional idTokenClaims?: TokenClaims & {}
-
localAccountId: string
-
Optional name?: string
-
Optional nativeAccountId?: string
-
tenantId: string
-
username: string
ApplicationTelemetry
ApplicationTelemetry: { appName: string; appVersion: string }
Type declaration
-
appName: string
-
appVersion: string
AuthOptions
Type declaration
-
-
-
Optional clientCapabilities?: string[]
-
clientId: string
AuthenticationResult
Authentication
Result: { 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; scopes: string[]; state?: string; tenantId: string; tokenType: string; uniqueId: string }
Type declaration
-
accessToken: string
-
-
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
-
scopes: string[]
-
Optional state?: string
-
tenantId: string
-
tokenType: string
-
uniqueId: string
AuthorityOptions
Authority
Options: { authorityMetadata: string; azureRegionConfiguration?: AzureRegionConfiguration; cloudDiscoveryMetadata: string; knownAuthorities: string[]; protocolMode: ProtocolMode }
Type declaration
-
authorityMetadata: string
-
-
cloudDiscoveryMetadata: string
-
knownAuthorities: string[]
-
AuthorizationCodePayload
AuthorizationCodePayload: { client_info?: string; cloud_graph_host_name?: string; cloud_instance_host_name?: string; cloud_instance_name?: string; code: string; msgraph_host?: string; nonce?: string; state?: string }
Type declaration
-
Optional client_info?: string
-
Optional cloud_graph_host_name?: string
-
Optional cloud_instance_host_name?: string
-
Optional cloud_instance_name?: string
-
code: string
-
Optional msgraph_host?: string
-
Optional nonce?: string
-
Optional state?: string
AzureRegion
AzureRegion: string
AzureRegionConfiguration
Azure
RegionConfiguration: { azureRegion?: AzureRegion; environmentRegion: string | undefined }
Type declaration
-
Optional azureRegion?: AzureRegion
-
environmentRegion: string | undefined
BaseAuthRequest
Base
AuthRequest: { authenticationScheme?: AuthenticationScheme; authority: string; azureCloudOptions?: AzureCloudOptions; claims?: string; correlationId: string; requestedClaimsHash?: string; resourceRequestMethod?: string; resourceRequestUri?: string; scopes: string[]; shrClaims?: string; shrNonce?: string; sshJwk?: string; sshKid?: string }
Type declaration
-
-
authority: string
-
-
Optional claims?: string
-
correlationId: string
-
Optional requestedClaimsHash?: string
-
Optional resourceRequestMethod?: string
-
Optional resourceRequestUri?: string
-
scopes: string[]
-
Optional shrClaims?: string
-
Optional shrNonce?: string
-
Optional sshJwk?: string
-
Optional sshKid?: string
ClientConfiguration
Type declaration
-
-
Optional clientCredentials?: ClientCredentials
-
Optional cryptoInterface?: ICrypto
-
Optional libraryInfo?: LibraryInfo
-
-
-
Optional persistencePlugin?: ICachePlugin | null
-
-
-
Optional storageInterface?: CacheManager
-
-
Optional telemetry?: TelemetryOptions
CommonAuthorizationCodeRequest
Common
AuthorizationCodeRequest: BaseAuthRequest & { ccsCredential?: CcsCredential; clientInfo?: string; code: string; codeVerifier?: string; enableSpaAuthorizationCode?: boolean; redirectUri: string; tokenBodyParameters?: StringDict; tokenQueryParameters?: StringDict }
CommonAuthorizationUrlRequest
Common
AuthorizationUrlRequest: BaseAuthRequest & { account?: AccountInfo; codeChallenge?: string; codeChallengeMethod?: string; domainHint?: string; extraQueryParameters?: StringDict; extraScopesToConsent?: string[]; loginHint?: string; nativeBroker?: boolean; nonce?: string; prompt?: string; redirectUri: string; responseMode: ResponseMode; sid?: string; state?: string; tokenQueryParameters?: StringDict }
CommonClientCredentialRequest
CommonEndSessionRequest
Common
EndSessionRequest: { account?: AccountInfo | null; correlationId: string; extraQueryParameters?: StringDict; idTokenHint?: string; logoutHint?: string; postLogoutRedirectUri?: string | null; state?: string }
Type declaration
-
Optional account?: AccountInfo | null
-
correlationId: string
-
Optional extraQueryParameters?: StringDict
-
Optional idTokenHint?: string
-
Optional logoutHint?: string
-
Optional postLogoutRedirectUri?: string | null
-
Optional state?: string
CommonOnBehalfOfRequest
Common
OnBehalfOfRequest: BaseAuthRequest & { oboAssertion: string; skipCache?: boolean }
CommonRefreshTokenRequest
CommonUsernamePasswordRequest
Common
UsernamePasswordRequest: BaseAuthRequest & { password: string; username: string }
DeviceCodeResponse
DeviceCodeResponse: { deviceCode: string; expiresIn: number; interval: number; message: string; userCode: string; verificationUri: string }
Type declaration
-
deviceCode: string
-
expiresIn: number
-
interval: number
-
message: string
-
userCode: string
-
verificationUri: string
ExternalTokenResponse
External
TokenResponse: Pick<ServerAuthorizationTokenResponse, "token_type" | "scope" | "expires_in" | "id_token"> & { access_token?: string; client_info?: string }
InProgressPerformanceEvent
Type declaration
-
discardMeasurement: () => void
-
-
-
flushMeasurement: () => void
-
LibraryStateObject
LibraryStateObject: { id: string; meta?: Record<string, string> }
Type declaration
-
id: string
-
Optional meta?: Record<string, string>
LoggerOptions
Logger
Options: { correlationId?: string; logLevel?: LogLevel; loggerCallback?: ILoggerCallback; piiLoggingEnabled?: boolean }
Type declaration
-
Optional correlationId?: string
-
Optional logLevel?: LogLevel
-
-
Optional piiLoggingEnabled?: boolean
NetworkRequestOptions
NetworkRequestOptions: { body?: string; headers?: Record<string, string>; proxyUrl?: string }
Type declaration
-
Optional body?: string
-
Optional headers?: Record<string, string>
-
Optional proxyUrl?: string
NetworkResponse
NetworkResponse<T>: { body: T; headers: Record<string, string>; status: number }
Type parameters
Type declaration
-
body: T
-
headers: Record<string, string>
-
status: number
PerformanceCallbackFunction
PerformanceEvent
Performance
Event: { appName?: string; appVersion?: string; authority: string; clientId: string; correlationId: string; durationMs?: number; endPageVisibility?: string | null; eventId: string; fromCache?: boolean | null; isNativeBroker?: boolean; libraryName: string; libraryVersion: string; name: PerformanceEvents; startPageVisibility?: string | null; startTimeMs: number; status: PerformanceEventStatus; success?: boolean | null }
Type declaration
-
Optional appName?: string
-
Optional appVersion?: string
-
authority: string
-
clientId: string
-
correlationId: string
-
Optional durationMs?: number
-
Optional endPageVisibility?: string | null
-
eventId: string
-
Optional fromCache?: boolean | null
-
Optional isNativeBroker?: boolean
-
libraryName: string
-
libraryVersion: string
-
-
Optional startPageVisibility?: string | null
-
startTimeMs: number
-
-
Optional success?: boolean | null
PkceCodes
PkceCodes: { challenge: string; verifier: string }
Type declaration
-
challenge: string
-
verifier: string
RequestThumbprint
Request
Thumbprint: { authenticationScheme?: AuthenticationScheme; authority: string; claims?: string; clientId: string; homeAccountIdentifier?: string; resourceRequestMethod?: string; resourceRequestUri?: string; scopes: string[]; shrClaims?: string; sshKid?: string }
Type declaration
-
-
authority: string
-
Optional claims?: string
-
clientId: string
-
Optional homeAccountIdentifier?: string
-
Optional resourceRequestMethod?: string
-
Optional resourceRequestUri?: string
-
scopes: string[]
-
Optional shrClaims?: string
-
Optional sshKid?: string
ServerAuthorizationCodeResponse
ServerAuthorizationCodeResponse: { accountId?: string; client_info?: string; cloud_graph_host_name?: string; cloud_instance_host_name?: string; cloud_instance_name?: string; code?: string; error?: string; error_description?: string; msgraph_host?: string; state?: string; suberror?: string }
Type declaration
-
Optional accountId?: string
-
Optional client_info?: string
-
Optional cloud_graph_host_name?: string
-
Optional cloud_instance_host_name?: string
-
Optional cloud_instance_name?: string
-
Optional code?: string
-
Optional error?: string
-
Optional error_description?: string
-
Optional msgraph_host?: string
-
Optional state?: string
-
Optional suberror?: string
ServerAuthorizationTokenResponse
Server
AuthorizationTokenResponse: { access_token?: string; client_info?: string; correlation_id?: string; error?: string; error_codes?: string[]; error_description?: string; expires_in?: number; ext_expires_in?: number; foci?: string; id_token?: string; key_id?: string; refresh_in?: number; refresh_token?: string; scope?: string; spa_code?: string; suberror?: string; timestamp?: string; token_type?: AuthenticationScheme; trace_id?: string }
Type declaration
-
Optional access_token?: string
-
Optional client_info?: string
-
Optional correlation_id?: string
-
Optional error?: string
-
Optional error_codes?: string[]
-
Optional error_description?: string
-
Optional expires_in?: number
-
Optional ext_expires_in?: number
-
Optional foci?: string
-
Optional id_token?: string
-
Optional key_id?: string
-
Optional refresh_in?: number
-
Optional refresh_token?: string
-
Optional scope?: string
-
Optional spa_code?: string
-
Optional suberror?: string
-
Optional timestamp?: string
-
-
Optional trace_id?: string
ServerTelemetryRequest
ServerTelemetryRequest: { apiId: number; clientId: string; correlationId: string; forceRefresh?: boolean; wrapperSKU?: string; wrapperVer?: string }
Type declaration
-
apiId: number
-
clientId: string
-
correlationId: string
-
Optional forceRefresh?: boolean
-
Optional wrapperSKU?: string
-
Optional wrapperVer?: string
SignedHttpRequest
SignedHttpRequest: { at?: string; client_claims?: string; cnf?: object; m?: string; nonce?: string; p?: string; q?: [string[], string]; ts?: number; u?: string }
Type declaration
-
Optional at?: string
-
Optional client_claims?: string
-
Optional cnf?: object
-
Optional m?: string
-
Optional nonce?: string
-
Optional p?: string
-
Optional q?: [string[], string]
-
Optional ts?: number
-
Optional u?: string
SignedHttpRequestParameters
Signed
HttpRequestParameters: Pick<BaseAuthRequest, "resourceRequestMethod" | "resourceRequestUri" | "shrClaims" | "shrNonce"> & { correlationId?: string }
StringDict
StringDict: {}
SystemOptions
SystemOptions: { preventCorsPreflight?: boolean; proxyUrl?: string; tokenRenewalOffsetSeconds?: number }
Type declaration
-
Optional preventCorsPreflight?: boolean
-
Optional proxyUrl?: string
-
Optional tokenRenewalOffsetSeconds?: number
TokenClaims
TokenClaims: { amr?: string[]; at?: string; aud?: string; 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; tid?: string; ts?: number; u?: string; upn?: string; ver?: string; x5c_ca?: string }
Type declaration
-
Optional amr?: string[]
-
Optional at?: string
-
Optional aud?: string
-
Optional cloud_instance_host_name?: string
-
Optional cnf?: { kid: string }
-
Optional emails?: string[]
-
Optional exp?: number
-
Optional home_oid?: string
-
Optional iat?: number
-
Optional idp?: string
-
Optional iss?: string
-
Optional login_hint?: string
-
Optional m?: string
-
Optional name?: string
-
Optional nbf?: number
-
Optional nonce?: string
-
Optional oid?: string
-
Optional p?: string
-
Optional preferred_username?: string
-
Optional roles?: string[]
-
Optional sid?: string
-
Optional sub?: string
-
Optional tid?: string
-
Optional ts?: number
-
Optional u?: string
-
Optional upn?: string
-
Optional ver?: string
-
Optional x5c_ca?: string
Account object with the following signature: