@azure/msal-node package

类

AuthError	MSAL.js 库引发的常规错误类。
ClientApplication	所有 ClientApplication 的基抽象类 - 公共和机密
ClientAssertion	机密客户端流中使用的 jwt-bearer 类型的客户端断言
ClientAuthError	在浏览器中运行的客户端代码中出现错误时引发的错误。
ClientConfigurationError	配置 MSAL.js 库时引发的错误。
ClientCredentialClient	OAuth2.0 客户端凭据授予
ConfidentialClientApplication	此类用于获取机密客户端应用程序（webApp、webAPI）的令牌。机密客户端应用程序将配置应用程序机密、客户端证书/断言（如适用）
CryptoProvider	此类实现 MSAL 节点的加密接口，该接口允许它执行 base64 编码和解码，生成加密随机 GUID，并使用 PKCE 为 OAuth 授权代码流实现代码证明密钥Exchange规范（此处 rfc： https://tools.ietf.org/html/rfc7636
DeviceCodeClient	OAuth2.0 设备代码客户端
DistributedCachePlugin	将数据序列化到缓存的缓存插件，并从缓存反序列化数据
InteractionRequiredAuthError	需要用户交互时引发的错误。
Logger	有助于将消息记录到特定位置的类。
ManagedIdentityApplication	用于初始化托管标识和标识服务的类
OnBehalfOfClient	on-Behalf-Of 客户端
PublicClientApplication	此类用于获取公共客户端应用程序（桌面、移动版）的令牌。公共客户端应用程序不受信任，无法安全地存储应用程序机密，因此只能请求用户名中的令牌。
ServerError	当服务器代码出错（例如不可用）时引发的错误。
TokenCache	内存中令牌缓存管理器
TokenCacheContext	此类实例有助于跟踪内存更改，从而做出读取和写入永久性缓存的决定
UsernamePasswordClient	Oauth2.0 密码授予客户端说明：我们仅支持公共客户端进行密码授予，仅用于纯测试目的

接口

IAppTokenProvider
ICacheClient	定义 getter 和 setter 的缓存的接口
ICachePlugin
IConfidentialClientApplication	用于定义公共 API 签名的 ConfidentialClientApplication 类的接口
ILoopbackClient	允许将默认环回服务器替换为自定义实现的 LoopbackClient 接口。
INativeBrokerPlugin
INetworkModule	用于发送后端请求的客户端网络接口。
IPartitionManager	定义 getter 方法的接口，用于获取用于缓存中标识数据的密钥
IPublicClientApplication	用于定义公共 API 签名的 PublicClientApplication 类的接口
ISerializableTokenCache
ITokenCache	客户端的令牌缓存接口，授予对缓存 API 的访问权限

类型别名

AccountInfo	具有以下签名的 Account 对象： homeAccountId - 此帐户对象的主页帐户标识符环境 - 颁发颁发者域所表示的令牌的实体（例如 login.microsoftonline.com） tenantId - 此帐户所属的完整租户或组织 ID username - preferred_username表示此帐户的id_token声明 localAccountId - 此帐户对象的本地特定于租户的帐户标识器，通常用于旧用例 name - 帐户的全名，包括给定名称和姓氏 idToken - 原始 ID 令牌 idTokenClaims - 对象包含来自 ID 令牌的声明 nativeAccountId - 用户的本机帐户 ID tenantProfiles - 映射帐户在浏览器中通过身份验证的每个租户的租户配置文件对象 dataBoundary - 从 clientInfo 提取的数据边界
AppTokenProviderParameters	IAppTokenProvider 扩展性的输入对象。 MSAL 将创建此对象，该对象可用于帮助创建 AppTokenProviderResult。 correlationId - 与请求关联的关联 ID tenantId - 必须为其提供令牌的租户 ID scopes - 必须为其提供令牌的范围声明 - 令牌必须满足的任何额外声明
AppTokenProviderResult	IAppTokenProvider extensiblity 的输出对象。 accessToken - 实际访问令牌（通常采用 JWT 格式），满足请求数据 AppTokenProviderParameters expiresInSeconds - 令牌在过期之前的时长（以秒为单位）。类似于 AAD 令牌响应中的“expires_in”字段。 refreshInSeconds - 令牌在应主动刷新之前多长时间。类似于 AAD 令牌响应中的“refresh_in”字段。
AuthenticationResult	从颁发机构令牌终结点返回的结果。 uniqueId - `oid` 或 `sub` 来自 ID 令牌的声明 tenantId - `tid` 来自 ID 令牌的声明 scopes - 为相应令牌验证的范围 account - 当前已登录用户的帐户对象表示形式 idToken - 作为响应的一部分收到的 ID 令牌 idTokenClaims - MSAL 相关的 ID 令牌声明 accessToken - 作为响应的一部分收到的访问令牌或 SSH 证书 fromCache - 布尔值表示令牌是否来自缓存 expiresOn - 表示访问令牌相对过期的 Javascript Date 对象 extExpiresOn - Javascript Date 对象，表示服务器中断时访问令牌的延长相对过期 refreshOn - Javascript Date 对象，表示访问令牌必须刷新之前的相对时间 state - 请求中由用户传入的值 familyId - 家庭 ID 标识符，通常用于刷新令牌 requestId - 作为响应的一部分返回的请求 ID
AuthorizationCodePayload	处理代码响应查询字符串或片段后返回的响应。
AuthorizationCodeRequest	用户通过请求对象从服务器获取令牌，交换有效的授权代码（OAuth2.0 授权代码流的第二回合） scopes - 应用程序请求访问的范围数组。 claims - 字符串化的声明请求，请求将添加到所有 /authorize 和 /token 调用 authority： - 颁发机构的 URL、MSAL 将从中获取令牌的安全令牌服务（STS）。如果在客户端应用程序对象上设置了颁发机构，则会替代该值。重写该值将导致每次进行颁发机构验证。如果将同一颁发机构用于所有请求，请在应用程序对象上设置，而不是请求。 correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。 redirectUri - 应用的重定向 URI，授权机构将在用户输入凭据和同意后重定向到该 URI。它必须与在门户中注册的其中一个重定向 URI 完全匹配。 tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射代码 - 用户在流的第一回合中获取的authorization_code。 codeVerifier - 用于获取authorization_code的相同code_verifier。如果在授权代码授予请求中使用 PKCE，则是必需的。有关详细信息，请参阅 PKCE RFC： https://tools.ietf.org/html/rfc7636 state - 由用户生成的唯一 GUID，该用户由用户缓存并在流的第一回合发送到服务器。此字符串由具有授权代码的服务器发送回。然后，将用户缓存状态与从服务器接收的状态进行比较，以降低 CSRF 攻击的风险。请参阅 https://datatracker.ietf.org/doc/html/rfc6819#section-3.6。
AuthorizationUrlRequest	用户传递的请求对象从服务器检索代码（授权代码授予流的第一回合） scopes - 应用程序请求访问的范围数组。 claims - 字符串化的声明请求，请求将添加到所有 /authorize 和 /token 调用 authority - 应用程序从中获取令牌的颁发机构的 URL。 correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。 redirectUri - 应用程序可以接收身份验证响应的重定向 URI。它必须与在 Azure 门户中注册的其中一个重定向 URI 完全匹配。 extraScopesToConsent - 当用户需要事先同意时，其他资源的作用域。 responseMode - 指定用于将身份验证结果发送到应用的方法。可以是查询、form_post或片段。如果未传入任何值，则默认为查询。 codeChallenge - 用于通过代码Exchange（PKCE）的密钥证明来保护授权代码授予。有关详细信息，请参阅 PKCE RCF：https://tools.ietf.org/html/rfc7636 codeChallengeMethod - 用于编码代码质询参数的代码验证程序的方法。可以是“plain”或“S256”。如果排除，则假定代码质询为纯文本。有关详细信息，请参阅 PKCE RCF： https://tools.ietf.org/html/rfc7636 state - 在令牌响应中也返回的请求中包含的值。随机生成的唯一值通常用于防止跨站点请求伪造攻击。该状态还用于在身份验证请求发生之前对应用中用户状态的信息进行编码。 prompt - 指示所需的用户交互类型。 login：将强制用户在该请求上输入其凭据，取消单一登录：将确保用户未显示任何交互式提示。如果无法通过单一登录完成请求，终结点将返回interaction_required错误同意：用户登录后将触发 OAuth 同意对话框，要求用户向应用授予权限select_account：将中断单一登录=提供帐户选择体验，其中列出了会话中的所有帐户或任何记住的帐户，或者选择使用其他帐户创建的选项：将用户定向到帐户创建体验而不是登录体验 account - 从 getAccount API 获取的 AccountInfo。在某些情况下，如果未提供 loginHint 和 sid 参数，则用于生成login_hint。 loginHint - 如果提前知道用户名/电子邮件地址，可用于预填充用户的登录页的用户名/电子邮件地址字段。应用通常在重新身份验证期间使用此参数，使用 preferred_username 声明从以前的登录中提取用户名。 sid - 会话 ID，会话的唯一标识符。作为 ID 令牌的可选声明提供。 domainHint - 提供有关用户应用于登录的租户或域的提示。域提示的值是租户的已注册域。 extraQueryParameters - 添加到 /authorize 调用的自定义查询参数的字符串到字符串映射 tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射 nonce - ID 令牌中返回的请求中包含的值。随机生成的唯一值通常用于缓解重播攻击。
AuthorizeResponse	/authorize 终结点可能返回的响应属性
AzureCloudOptions	AzureCloudInstance 特定选项 azureCloudInstance - 字符串枚举为 soverign 和公有云颁发机构提供短表示法 tenant - 预配以提供租户信息
BrokerOptions	使用此配置以下中转站选项： nativeBrokerPlugin - 本机代理实现（应从 msal-node-extensions 导入）注意：这些选项仅适用于使用授权代码流的 PublicClientApplications
CacheKVStore	内存中缓存的键值存储
CacheOptions	使用此选项配置以下缓存配置选项： cachePlugin - 用于读取令牌缓存并将其写入磁盘的插件。
ClientAssertionCallback
ClientCredentialRequest	CommonClientCredentialRequest scopes - 应用程序请求访问的范围数组。通常仅包含单个资源的 .default 范围。请参阅：https://dotnet.territoriali.olinfo.it/azure/active-directory/develop/scopes-oidc#the-default-scope authority - 颁发机构 URL、MSAL 将从中获取令牌的安全令牌服务（STS）。 correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。 skipCache - 跳过令牌缓存查找并强制请求授权以获取新令牌。默认值为 false。 clientAssertion - 一个断言字符串或一个回调函数，用于返回断言字符串（两者都是客户端凭据流中使用的 Base64Url 编码的有符号 JWT） tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射
Configuration	使用配置对象配置 MSAL 并初始化客户端应用程序对象身份验证：可在其中配置身份验证元素，例如 clientID、用于针对Microsoft标识平台进行身份验证的颁发机构 broker：这是配置中转站选项的位置缓存：这是配置缓存位置的位置系统：可在其中配置网络客户端、记录器遥测：可在其中配置遥测选项
DeviceCodeRequest	Oauth2 设备代码流的参数。 scopes - 应用程序请求访问的范围数组。 authority： - 颁发机构的 URL、MSAL 将从中获取令牌的安全令牌服务（STS）。如果在客户端应用程序对象上设置了颁发机构，则会替代该值。重写该值将导致每次进行颁发机构验证。如果将同一颁发机构用于所有请求，请在应用程序对象上设置，而不是请求。 correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。 deviceCodeCallback - 包含设备代码响应的回调。应向最终用户显示消息。然后，最终用户可以导航到verification_uri、输入user_code和输入凭据。 cancel - 用于取消设备代码终结点轮询的布尔值。当用户在单独的设备上进行身份验证时，MSAL 会轮询安全令牌服务的令牌终结点，以获取设备代码响应中指定的时间间隔（通常为 15 分钟）。若要停止轮询并取消请求，请设置 cancel=true。 extraQueryParameters - 添加到查询字符串的自定义查询参数的字符串到字符串映射
IdTokenClaims	描述 MSAL 已知的 ID 令牌声明的类型。
InMemoryCache	用于处理具有已定义类型的内存中数据对象的间歇性类型
InteractiveRequest	用户传递的请求对象以配置 acquireTokenInteractive API openBrowser - 用于在用户的系统上打开浏览器实例的函数。 scopes - 应用程序请求访问的范围数组。 successTemplate： - 成功获取令牌后，要显示在打开的浏览器实例上的模板。 errorTemplate - 令牌获取失败时要显示在打开的浏览器实例上的模板。 windowHandle - 在本机中转站流中用于正确为本机代理窗口提供父级 loopbackClient - 环回服务器的自定义实现，用于侦听授权代码响应。
JsonCache	在应用实例化期间从提供给配置的缓存 blob 中读取的缓存格式
ManagedIdentityConfiguration
ManagedIdentityIdParams
ManagedIdentityRequestParams	ManagedIdentityRequest claims - 一个字符串化声明请求，用于确定是否应跳过缓存 forceRefresh - 强制托管标识请求跳过缓存并发出网络调用（如果为 true） resource - 请求访问受保护 API 的资源。它应采用“ResourceIdUri”或“ResourceIdUri/.default”格式。例如https://management.azure.net，或者，对于Microsoft Graph，`https://graph.microsoft.com/.default`
NetworkRequestOptions	网络请求 API 允许的选项。
NetworkResponse
NodeAuthOptions	clientId - 应用程序的客户端 ID。 authority - 颁发机构的 URL。如果未设置任何值，则默认值为 `https://login.microsoftonline.com/common`. knownAuthorities - Azure B2C 和 ADFS 所需的。将在客户端应用程序中使用的所有颁发机构。仅应传入颁发机构的主机。 clientSecret - 应用程序在请求令牌时使用的机密字符串。仅在机密客户端应用程序中使用。可以在Azure应用注册门户中创建。 clientAssertion - 包含断言字符串或回调函数的 ClientAssertion 对象，该函数返回应用程序在请求令牌时使用的断言字符串，以及断言的类型（urn：ietf：params：oauth：client-assertion-type：jwt-bearer）。仅在机密客户端应用程序中使用。 clientCertificate - 应用程序在请求令牌时使用的证书。仅在机密客户端应用程序中使用。需要证书的十六进制编码 X.509 SHA-1 或 SHA-256 指纹，以及 PEM 编码私钥（字符串应包含 -----BEGIN 私钥----- ... -----END PRIVATE KEY-----） protocolMode - 枚举，表示 msal 遵循的协议。用于配置正确的终结点。 skipAuthorityMetadataCache - 一个标志，用于选择在授权初始化期间是否使用本地元数据缓存。默认值为 false。 encodeExtraQueryParams - 一个标志，用于选择是否对请求 URL 中的额外查询参数进行编码。默认值为 false。
NodeSystemOptions	用于配置记录器和 http 客户端选项的类型记录器 - 用于初始化 Logger 对象;TODO：展开记录器详细信息或记录器文档链接 networkClient - 用于所有 http 获取和发布调用的 Http 客户端。默认使用 MSAL 的默认 http 客户端。
NodeTelemetryOptions
OnBehalfOfRequest	scopes - 应用程序请求访问的范围数组。 authority - 颁发机构 URL、MSAL 将从中获取令牌的安全令牌服务（STS）。 correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。 oboAssertion - 发送到中间层 API 的访问令牌。此令牌必须具有发出此 OBO 请求的应用受众。 skipCache - 跳过令牌缓存查找并强制请求授权以获取新令牌。默认值为 false。 tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射
RefreshTokenRequest	CommonRefreshTokenRequest scopes - 应用程序请求访问的范围数组。 claims - 字符串化的声明请求，请求将添加到所有 /authorize 和 /token 调用 authority - 颁发机构 URL、MSAL 将从中获取令牌的安全令牌服务（STS）。 correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。 refreshToken - 从先前向标识提供者请求返回的刷新令牌。 tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射 forceCache - 强制 MSAL 在缓存中没有帐户时缓存刷新令牌流响应。用于迁移方案。
SerializedAccessTokenEntity	访问令牌凭据类型
SerializedAccountEntity	帐户类型
SerializedAppMetadataEntity	AppMetadata 类型
SerializedIdTokenEntity	Idtoken 凭据类型
SerializedRefreshTokenEntity	刷新令牌凭据类型
SignOutRequest
SilentFlowRequest	用户传递的 SilentFlow 参数以无提示方式检索凭据 scopes - 应用程序请求访问的范围数组。声明 - 字符串化的声明请求，将添加到所有 /authorize 和 /token 调用。在无提示请求中包括时，将跳过缓存查找，并刷新令牌。 authority - 应用程序从中获取令牌的颁发机构的 URL。 correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。 tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射 account - 用于查找凭据的帐户实体。 forceRefresh - 如果为 true，则强制无提示请求进行网络调用。
UsernamePasswordRequest	用户传递的 UsernamePassword 参数检索凭据注意：最新的 OAuth 2.0 安全最佳做法完全不允许授予密码。此流已添加用于内部测试。 scopes - 应用程序请求访问的范围数组。声明 - 字符串化的声明请求，将添加到所有 /authorize 和 /token 调用。在无提示请求中包括时，将跳过缓存查找，并刷新令牌。 authority - 应用程序从中获取令牌的颁发机构的 URL。 correlationId - 每个请求的唯一 GUID 集，用于跟踪用于遥测目的的请求端到端。 username - 客户端的用户名 password - credentials tokenQueryParameters - 添加到 /token 调用的自定义查询参数的字符串映射

枚举

LogLevel

日志消息级别。

变量

AzureCloudInstance
ManagedIdentitySourceNames	托管标识源名称
ProtocolMode	MSAL 支持的协议模式。
ResponseMode	允许response_mode的值
AuthErrorMessage	包含错误代码和消息使用的字符串常量的 AuthErrorMessage 类。
ClientAuthErrorMessage	错误代码和消息使用的字符串常量。
ClientConfigurationErrorMessage	ClientConfigurationErrorMessage 类，包含错误代码和消息使用的字符串常量。
InteractionRequiredAuthErrorMessage	SDK 定义的交互所需的错误
PromptValue	我们考虑在请求而不是字符串中发出此“枚举”，但看起来像允许的提示值列表在过去几年中不断更改。某些内部合作伙伴也有一些未记录的提示值，因此选择泛型“string”类型而不是“枚举”
version

变量详细信息

AzureCloudInstance

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" }

类型

{ 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" }

ManagedIdentitySourceNames

托管标识源名称

ManagedIdentitySourceNames: { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }

类型

{ APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }

ProtocolMode

MSAL 支持的协议模式。

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

类型

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

ResponseMode

允许response_mode的值

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

类型

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

AuthErrorMessage

警告

现已弃用此 API。

Use AuthErrorCodes instead

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

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

类型

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

ClientAuthErrorMessage

警告

现已弃用此 API。

Use ClientAuthErrorCodes instead

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

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 } }

类型

{ 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

警告

现已弃用此 API。

Use ClientConfigurationErrorCodes instead

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 } }

类型

{ 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 } }

InteractionRequiredAuthErrorMessage

警告

现已弃用此 API。

Use InteractionRequiredAuthErrorCodes instead

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 } }

类型

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

PromptValue

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

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

类型

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

version

version: "3.8.10"

类型

"3.8.10"