ExtendedUserTokenProvider interface
警告
この API は非推奨になりました。
Use UserTokenClient instead.
BotAdapters のユーザー トークン OAuth シングル サインオンとトークン交換 API のインターフェイス
- Extends
メソッド
| exchange |
シングル サインオンなどのトークン交換操作を実行します。 |
| exchange |
シングル サインオンなどのトークン交換操作を実行します。 |
| get |
トークン サーバーを使用してユーザーをサインアウトします。 |
| get |
SigninCard の一部として送信できるトークン サーバーからサインイン リンクを取得します。 |
| get |
接続名のサインインのためにユーザーに送信される未加工のサインイン リソースを取得します。 |
| get |
接続名のサインインのためにユーザーに送信される未加工のサインイン リソースを取得します。 |
| get |
接続名のサインインのためにユーザーに送信される未加工のサインイン リソースを取得します。 |
| get |
サインイン フロー内のユーザーの OAuth トークンを取得します。 |
| sign |
トークン サーバーを使用してユーザーをサインアウトします。 |
継承されたメソッド
| get |
ボットの 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>
getSignInLink(TurnContext, string, CoreAppCredentials)
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 から継承