次の方法で共有

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>>

対応する TokenResponse への resourceUrls のディクショナリ。

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>