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

將與令牌相關聯的使用者標識碼。

connectionName

string

要使用的驗證連線名稱。

channelId

string

將與令牌相關聯的通道標識碼。

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

將與令牌相關聯的使用者標識碼。

connectionName

string

要使用的驗證連線名稱。

resourceUrls

string[]

要為其擷取令牌的資源URL清單。

channelId

string

將與令牌相關聯的通道標識碼。

傳回

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

將與令牌相關聯的使用者標識碼。

channelId

string

將與令牌相關聯的通道標識碼。

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

將與令牌相關聯的使用者標識碼。

connectionName

string

要使用的驗證連線名稱。

channelId

string

將與令牌相關聯的通道標識碼。

magicCode

string

（選擇性）選擇性使用者輸入要驗證的程序代碼。

傳回

Promise<TokenResponse>

TokenResponse 物件。

signOutUser(string, string, string)

使用令牌伺服器將用戶註銷。

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

參數

userId

string

將與令牌相關聯的使用者標識碼。

connectionName

string

要使用的驗證連線名稱。

channelId

string

將與令牌相關聯的通道標識碼。

傳回

Promise<void>