CertificateAppCredentials class

包:

botframework-connector

CertificateAppCredentials 身份验证实现

Extends

AppCredentials

构造函数

CertificateAppCredentials(string, string, string, string, string)

初始化 CertificateAppCredentials 类的新实例。

属性

certificatePrivateKey
certificateThumbprint
oAuthEndpoint	获取要使用的 OAuth 终结点。 设置要使用的 OAuth 终结点。
oAuthScope	获取要使用的 OAuth 范围。 设置要使用的 OAuth 范围。

继承属性

appId
tokenCacheKey

继承的方法

getToken(boolean)	获取 OAuth 访问令牌。
isTrustedServiceUrl(string)	检查服务 URL 是否为受信任的主机。
signRequest(WebResource)	将凭据应用于 HTTP 请求。
trustServiceUrl(string, Date)	将服务 URL 的主机添加到受信任的主机。 如果未提供过期时间，则到期日期将是当前 (utc) 日期 + 1 天。

构造函数详细信息

CertificateAppCredentials(string, string, string, string, string)

初始化 CertificateAppCredentials 类的新实例。

new CertificateAppCredentials(appId: string, certificateThumbprint: string, certificatePrivateKey: string, channelAuthTenant?: string, oAuthScope?: string)

参数

appId

string

与证书相关的 Microsoft 应用程序 ID。

certificateThumbprint

string

证书的十六进制编码指纹。

certificatePrivateKey

string

PEM 编码的证书私钥。

channelAuthTenant

string

可选。 oauth 令牌租户。

oAuthScope

string

可选。 令牌的范围。

属性详细信息

certificatePrivateKey

certificatePrivateKey: string

属性值

string

certificateThumbprint

certificateThumbprint: string

属性值

string

oAuthEndpoint

获取要使用的 OAuth 终结点。 设置要使用的 OAuth 终结点。

string oAuthEndpoint

属性值

string

要使用的 OAuthEndpoint。

oAuthScope

获取要使用的 OAuth 范围。 设置要使用的 OAuth 范围。

string oAuthScope

属性值

string

要使用的 OAuth 范围。

继承属性详细信息

appId

appId: string

属性值

string

继承自AppCredentials.appId

tokenCacheKey

tokenCacheKey: string

属性值

string

继承自AppCredentials.tokenCacheKey

继承的方法详细信息

getToken(boolean)

获取 OAuth 访问令牌。

function getToken(forceRefresh?: boolean): Promise<string>

参数

forceRefresh

boolean

如果为 True，则强制刷新令牌;如果存在缓存令牌，则为 false。

返回

Promise<string>

一个 Promise，表示排队要执行的工作。

注解

如果承诺成功，则结果包含访问令牌字符串。

继承自AppCredentials.getToken

isTrustedServiceUrl(string)

警告

现已弃用此 API。

检查服务 URL 是否为受信任的主机。

static function isTrustedServiceUrl(serviceUrl: string): boolean

参数

serviceUrl

string

服务 URL

返回

boolean

如果服务 URL 的主机受信任，则为 True;否则为 False。

继承自AppCredentials.isTrustedServiceUrl

signRequest(WebResource)

将凭据应用于 HTTP 请求。

function signRequest(webResource: WebResource): Promise<WebResource>

参数

webResource

WebResource

WebResource HTTP 请求。

返回

Promise<WebResource>

表示异步操作的 Promise。

继承自AppCredentials.signRequest

trustServiceUrl(string, Date)

警告

现已弃用此 API。

将服务 URL 的主机添加到受信任的主机。 如果未提供过期时间，则到期日期将是当前 (utc) 日期 + 1 天。

static function trustServiceUrl(serviceUrl: string, expiration?: Date)

参数

serviceUrl

string

服务 URL

expiration

Date

继承自AppCredentials.trustServiceUrl