UserTokenClient class

包:

botframework-connector

用于访问用户令牌服务的客户端。

方法

exchangeToken(string, string, string, TokenExchangeRequest)	执行令牌交换操作，例如单一登录。
getAadTokens(string, string, string[], string)	检索配置连接上特定资源的 Azure Active Directory 令牌。
getSignInResource(string, Activity, string)	获取要发送给用户用于登录的连接名称的原始登录链接。
getTokenStatus(string, string, string)	检索给定用户的每个已配置连接的令牌状态。
getUserToken(string, string, string, string)	尝试检索登录流中的用户的令牌。
signOutUser(string, string, string)	使用令牌服务器注销用户。

方法详细信息

exchangeToken(string, string, string, TokenExchangeRequest)

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

function exchangeToken(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

参数

userId

string

将与令牌关联的用户 ID。

connectionName

string

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

channelId

string

将与令牌关联的通道 ID。

exchangeRequest

TokenExchangeRequest

交换请求详细信息，可以是要交换的令牌，要么是交换的 URI。

返回

Promise<TokenResponse>

TokenResponse 对象。

getAadTokens(string, string, string[], string)

检索配置连接上特定资源的 Azure Active Directory 令牌。

function getAadTokens(userId: string, connectionName: string, resourceUrls: string[], channelId: string): Promise<Record<string, TokenResponse>>

参数

userId

string

将与令牌关联的用户 ID。

connectionName

string

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

resourceUrls

string[]

要为其检索令牌的资源 URL 列表。

channelId

string

将与令牌关联的通道 ID。

返回

Promise<Record<string, TokenResponse>>

resourceUrls 的字典，指向相应的 TokenResponse。

getSignInResource(string, Activity, string)

获取要发送给用户用于登录的连接名称的原始登录链接。

function getSignInResource(connectionName: string, activity: Activity, finalRediect: string): Promise<SignInUrlResponse>

参数

connectionName

string

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

activity

Activity

要从中派生令牌交换状态的 活动。

finalRediect

string

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

返回

Promise<SignInUrlResponse>

SignInUrlResponse。

getTokenStatus(string, string, string)

检索给定用户的每个已配置连接的令牌状态。

function getTokenStatus(userId: string, channelId: string, includeFilter: string): Promise<TokenStatus[]>

参数

userId

string

将与令牌关联的用户 ID。

channelId

string

将与令牌关联的通道 ID。

includeFilter

string

includeFilter。

返回

Promise<TokenStatus[]>

TokenStatus 对象的列表。

getUserToken(string, string, string, string)

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

function getUserToken(userId: string, connectionName: string, channelId: string, magicCode: string): Promise<TokenResponse>

参数

userId

string

将与令牌关联的用户 ID。

connectionName

string

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

channelId

string

将与令牌关联的通道 ID。

magicCode

string

（可选）可选用户输入代码进行验证。

返回

Promise<TokenResponse>

TokenResponse 对象。

signOutUser(string, string, string)

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

function signOutUser(userId: string, connectionName: string, channelId: string): Promise<void>

参数

userId

string

将与令牌关联的用户 ID。

connectionName

string

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

channelId

string

将与令牌关联的通道 ID。

返回

Promise<void>