ExtendedUserTokenProvider interface

参考

包:: botbuilder-core

警告

现已弃用此 API。

Use UserTokenClient instead.

BotAdapter 的用户令牌 OAuth 单一登录和令牌交换 API 的接口

Extends: IUserTokenProvider

方法

exchangeToken(TurnContext, string, string, TokenExchangeRequest)	执行令牌交换操作，例如进行单一登录。
exchangeToken(TurnContext, string, string, TokenExchangeRequest, CoreAppCredentials)	执行令牌交换操作，例如进行单一登录。
getAadTokens(TurnContext, string, string[], CoreAppCredentials)	使用令牌服务器注销用户。
getSignInLink(TurnContext, string, CoreAppCredentials)	从令牌服务器获取可以作为 SigninCard 的一部分发送的登录链接。
getSignInResource(TurnContext, string)	获取要发送给用户进行登录的原始登录资源，以获取连接名称。
getSignInResource(TurnContext, string, string, string)	获取要发送给用户进行登录的原始登录资源，以获取连接名称。
getSignInResource(TurnContext, string, string, string, CoreAppCredentials)	获取要发送给用户进行登录的原始登录资源，以获取连接名称。
getUserToken(TurnContext, string, string, CoreAppCredentials)	检索登录流中的用户的 OAuth 令牌。
signOutUser(TurnContext, string, string, CoreAppCredentials)	使用令牌服务器注销用户。

继承的方法

getTokenStatus(TurnContext, string, string, any)

使用机器人的 AppCredentials 为给定用户检索每个已配置连接的令牌状态。

方法详细信息

exchangeToken(TurnContext, string, string, TokenExchangeRequest)

执行令牌交换操作，例如进行单一登录。

function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

connectionName: string

要使用的身份验证连接的名称。

userId: string

将与令牌关联的用户 ID。

tokenExchangeRequest: TokenExchangeRequest

交换请求详细信息，要交换的令牌或要交换的 URI。

Promise<TokenResponse>

exchangeToken(TurnContext, string, string, TokenExchangeRequest, CoreAppCredentials)

执行令牌交换操作，例如进行单一登录。

function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials: CoreAppCredentials): Promise<TokenResponse>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

connectionName: string

要使用的身份验证连接的名称。

userId: string

将与令牌关联的用户 ID。

tokenExchangeRequest: TokenExchangeRequest

交换请求详细信息，要交换的令牌或要交换的 URI。

appCredentials: CoreAppCredentials

Promise<TokenResponse>

getAadTokens(TurnContext, string, string[], CoreAppCredentials)

使用令牌服务器注销用户。

function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], appCredentials?: CoreAppCredentials): Promise<[key: string]: TokenResponse>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

connectionName: string

要使用的身份验证连接的名称。

resourceUrls: string[]

appCredentials: CoreAppCredentials

Promise<[key: string]: TokenResponse>

getSignInLink(TurnContext, string, CoreAppCredentials)

从令牌服务器获取可以作为 SigninCard 的一部分发送的登录链接。

function getSignInLink(context: TurnContext, connectionName: string, appCredentials?: CoreAppCredentials): Promise<string>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

connectionName: string

要使用的身份验证连接的名称。

appCredentials: CoreAppCredentials

Promise<string>

getSignInResource(TurnContext, string)

获取要发送给用户进行登录的原始登录资源，以获取连接名称。

function getSignInResource(context: TurnContext, connectionName: string): Promise<SignInUrlResponse>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

connectionName: string

要使用的身份验证连接的名称。

Promise<SignInUrlResponse>

getSignInResource(TurnContext, string, string, string)

获取要发送给用户进行登录的原始登录资源，以获取连接名称。

function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string): Promise<SignInUrlResponse>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

connectionName: string

要使用的身份验证连接的名称。

userId: string

将与令牌关联的用户 ID。

finalRedirect: string

OAuth 流将重定向到的最终 URL。

Promise<SignInUrlResponse>

getSignInResource(TurnContext, string, string, string, CoreAppCredentials)

获取要发送给用户进行登录的原始登录资源，以获取连接名称。

function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string, appCredentials?: CoreAppCredentials): Promise<SignInUrlResponse>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

connectionName: string

要使用的身份验证连接的名称。

userId: string

将与令牌关联的用户 ID。

finalRedirect: string

OAuth 流将重定向到的最终 URL。

appCredentials: CoreAppCredentials

Promise<SignInUrlResponse>

getUserToken(TurnContext, string, string, CoreAppCredentials)

检索登录流中的用户的 OAuth 令牌。

function getUserToken(context: TurnContext, connectionName: string, magicCode?: string, appCredentials?: CoreAppCredentials): Promise<TokenResponse>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

connectionName: string

要使用的身份验证连接的名称。

magicCode: string

(可选) 可选用户输入的代码进行验证。

appCredentials: CoreAppCredentials

Promise<TokenResponse>

signOutUser(TurnContext, string, string, CoreAppCredentials)

使用令牌服务器注销用户。

function signOutUser(context: TurnContext, connectionName: string, userId?: string, appCredentials?: CoreAppCredentials): Promise<void>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

connectionName: string

要使用的身份验证连接的名称。

userId: string

要注销的用户的用户 ID。

appCredentials: CoreAppCredentials

Promise<void>

继承的方法详细信息

getTokenStatus(TurnContext, string, string, any)

使用机器人的 AppCredentials 为给定用户检索每个已配置连接的令牌状态。

function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>

参数

context: TurnContext

与用户当前轮次聊天的上下文。

userId: string

为其检索令牌状态的用户 ID。

includeFilter: string

要包含的连接的逗号分隔列表。空白将返回所有已配置连接的令牌状态。

oAuthAppCredentials: any

OAuth 的应用凭据。

Promise<any[]>

继承自IUserTokenProvider.getTokenStatus

通过

ExtendedUserTokenProvider interface

方法

继承的方法

方法详细信息

exchangeToken(TurnContext, string, string, TokenExchangeRequest)

参数

返回

exchangeToken(TurnContext, string, string, TokenExchangeRequest, CoreAppCredentials)

参数

返回

getAadTokens(TurnContext, string, string[], CoreAppCredentials)

参数

返回

getSignInLink(TurnContext, string, CoreAppCredentials)

参数

返回

getSignInResource(TurnContext, string)

参数

返回

getSignInResource(TurnContext, string, string, string)

参数

返回

getSignInResource(TurnContext, string, string, string, CoreAppCredentials)

参数

返回

getUserToken(TurnContext, string, string, CoreAppCredentials)

参数

返回

signOutUser(TurnContext, string, string, CoreAppCredentials)

参数

返回

继承的方法详细信息

getTokenStatus(TurnContext, string, string, any)

参数

返回

其他资源