UserTokenClientImpl class

パッケージ:

botframework-connector

Extends

UserTokenClient

コンストラクター

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

メソッド

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)	トークン サーバーを使用してユーザーをサインアウトします。

コンストラクターの詳細

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

new UserTokenClientImpl(appId: string, credentials: ServiceClientCredentials, oauthEndpoint: string, connectorClientOptions?: ConnectorClientOptions)

パラメーター

appId

string

appId。

credentials

ServiceClientCredentials

OAuth の AppCredentials。

oauthEndpoint

string

OAuth API エンドポイント。

connectorClientOptions

ConnectorClientOptions

ConnectorClientOptions オブジェクト。

メソッドの詳細

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>

操作の結果を表す Promise。

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 への resourceUrl のディクショナリの約束。

getSignInResource(string, Activity, string)

サインインのためにユーザーに送信される生のサインイン リソースを非同期的に取得します。

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

パラメーター

connectionName

string

使用する認証接続の名前。

activity

Activity

トークン交換状態の派生元のアクティビティ。

finalRedirect

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

トークンの状態の配列を持つ promise。

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>

トークン応答。

signOutUser(string, string, string)

トークン サーバーを使用してユーザーをサインアウトします。

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

パラメーター

userId

string

トークンに関連付けられるユーザー ID。

connectionName

string

使用する認証接続の名前。

channelId

string

トークンに関連付けられるチャネル ID。

戻り値

Promise<void>