@azure/msal-common package

function buildAccountToCache(cacheStorage: CacheManager, authority: Authority, homeAccountId: string, base64Decode: (input: string) => string, correlationId: string, idTokenClaims?: TokenClaims, clientInfo?: string, environment?: string, claimsTenantId?: null | string, authCodePayload?: AuthorizationCodePayload, nativeAccountId?: string, logger?: Logger): AccountEntity

参数

返回

用于从服务器 clientInfo 字符串生成客户端信息对象的函数

function buildClientInfo(rawClientInfo: string, base64Decode: (input: string) => string): ClientInfo

参数

返回

用于从缓存 homeAccountId 字符串生成客户端信息对象的函数

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

参数

返回

function buildStaticAuthorityOptions(authOptions: Partial<AuthorityOptions>): StaticAuthorityOptions

参数

返回

生成租户配置文件

function buildTenantProfile(homeAccountId: string, localAccountId: string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile

参数

返回

function createAuthError(code: string, additionalMessage?: string): AuthError

参数

返回

用于在 CacheError 对象中包装浏览器错误的帮助程序函数

function createCacheError(e: unknown): CacheError

参数

返回

function createClientAuthError(errorCode: string, additionalMessage?: string): ClientAuthError

参数

返回

function createClientConfigurationError(errorCode: string): ClientConfigurationError

参数

返回

创建 InteractionRequiredAuthError

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

参数

返回

为失败的网络请求创建 NetworkError 对象

function createNetworkError(error: AuthError, httpStatus?: number, responseHeaders?: Record<string, string>, additionalError?: Error): NetworkError

参数

返回

NetworkError 对象

function formatAuthorityUri(authorityUri: string): string

参数

返回

function getRequestThumbprint(clientId: string, request: BaseAuthRequest, homeAccountId?: string): RequestThumbprint

参数

返回

从可用的 ID 令牌声明中获取 tenantId，该声明设置为具有以下优先级的凭据领域：

1. tid - 如果令牌是从 Azure AD 租户 tid 获取的，则会存在
2. tfp - 如果令牌是从新式 B2C 租户 tfp 获取的，则应存在
3. acr - 如果从旧 B2C 租户 acr 获取令牌，则应显示 Downcased，以匹配不区分大小写的比较要求

function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

参数

返回

如果 tenantId 与 homeAccountId 的 utid 部分匹配，则返回 true

function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: string): boolean

参数

返回

用特定于租户的帐户信息替换从传入的 ID 令牌声明中获取的租户配置文件变化的帐户信息

function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, idTokenSecret?: string): AccountInfo

参数

返回

与 AAD 颁发机构相关的字符串常量

AADAuthorityConstants: { COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

类型

身份验证请求的类型

AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

类型

MSAL 支持的颁发机构类型。

AuthorityType: { Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

类型

AzureCloudInstance: { AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }

类型

缓存中的帐户类型

CacheAccountType: { ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

类型

指定从标识提供者提取访问令牌的原因

CacheOutcome: { CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

类型

合并所有缓存类型

CacheType: { ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

类型

CcsCredentialType: { HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

类型

声明请求密钥

ClaimsRequestKeys: { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

类型

存储在缓存中的凭据类型

CredentialType: { ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

类型

EncodingTypes: { BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

类型

允许grant_type

GrantType: { AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

类型

请求标头名称

HeaderNames: { AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

类型

HttpMethod: { GET: "GET", POST: "POST" }

类型

HttpStatus: { BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

类型

JsonWebTokenTypes: { Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

类型

response_type允许的值

OAuthResponseType: { CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

类型

密码授予参数

PasswordGrantConstants: { password: "password", username: "username" }

类型

持久缓存密钥 MSAL，该密钥在用户登录时保持。

PersistentCacheKeys: { ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

类型

MSAL 支持的协议模式。

ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

类型

允许response_mode的值

ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

类型

服务器响应类型的允许值

ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }

类型

包含错误代码和消息使用的字符串常量的 AuthErrorMessage 类。

AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

类型

错误代码和消息使用的字符串常量。

ClientAuthErrorMessage: { DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }

类型

ClientConfigurationErrorMessage 类，包含错误代码和消息使用的字符串常量。

ClientConfigurationErrorMessage: { authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }

类型

codeVerifier 的允许值

CodeChallengeMethodValues: { PLAIN: string, S256: string }

类型

Constants: { AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

类型

DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto

类型

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

类型

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

类型

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

类型

IntFields: ReadonlySet<string>

类型

SDK 定义的交互所需的错误

InteractionRequiredAuthErrorMessage: { bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }

类型

OIDC_DEFAULT_SCOPES: string[]

类型

ONE_DAY_IN_MS: 86400000

类型

我们考虑在请求而不是字符串中发出此“枚举”，但看起来像允许的提示值列表在过去几年中不断更改。 某些内部合作伙伴也有一些未记录的提示值，因此选择泛型“string”类型而不是“枚举”

PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

类型

StubbedNetworkModule: INetworkModule

类型

THE_FAMILY_ID: "1"

类型

与限制相关的常量

ThrottlingConstants: { DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

类型

version: "15.17.0"

类型