ExtendedUserTokenProvider interface

警告

现已弃用此 API。

Use UserTokenClient instead.

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

扩展

方法

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>

从令牌服务器获取一个登录链接,该链接可以作为 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