UserTokenProvider インターフェイス

パッケージ:

com.microsoft.bot.builder

Maven 成果物:

com.microsoft.bot:bot-builder:4.14.3

public interface UserTokenProvider

OAuth プロバイダー。

メソッドの概要

修飾子と型	メソッドと説明
abstract java.util.concurrent.CompletableFuture<TokenResponse>	exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest) シングル サインオンなどのトークン交換操作を実行します。
abstract java.util.concurrent.CompletableFuture<TokenResponse>	exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest) シングル サインオンなどのトークン交換操作を実行します。
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId) カスタマイズされたアプリ資格情報を使用して、構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。
default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls) 構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId) 構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName) カスタマイズされたアプリ資格情報を使用して、接続名のサインイン用にユーザーに送信される未加工のサインイン リンクを取得します。
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) カスタマイズされたアプリ資格情報を使用して、接続名のサインイン用にユーザーに送信される未加工のサインイン リンクを取得します。
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, String connectionName) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
abstract java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
abstract java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, String connectionName) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
abstract java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect) 接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter) カスタマイズされたアプリ資格情報を使用して、特定のユーザーに対して構成された各接続のトークンの状態を取得します。
default java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext turnContext, String userId) 特定のユーザーに対して構成された各接続のトークンの状態を取得します。
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext turnContext, String userId, String includeFilter) 特定のユーザーに対して構成された各接続のトークンの状態を取得します。
abstract java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode) カスタマイズされたアプリ資格情報を使用して、ログイン フロー内のユーザーのトークンの取得を試みます。
abstract java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext turnContext, String connectionName, String magicCode) ログイン フロー内のユーザーのトークンの取得を試みます。
default java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext turnContext) トークン サーバーを使用してユーザーをサインアウトします。
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId) カスタマイズされたアプリ資格情報を使用して、トークン サーバーを使用してユーザーをサインアウトします。
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext turnContext, String connectionName, String userId) トークン サーバーを使用してユーザーをサインアウトします。

メソッドの詳細

exchangeToken

public abstract CompletableFuture exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

シングル サインオンなどのトークン交換操作を実行します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

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

userId - トークンに関連付けられているユーザー ID。.

exchangeRequest - 交換要求の詳細。交換するトークンまたは交換する URI。

Returns:

CompleteableFuture が完了すると、交換されたトークンが返されます。

exchangeToken

public abstract CompletableFuture exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

シングル サインオンなどのトークン交換操作を実行します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

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

userId - トークンに関連付けられているユーザー ID。.

exchangeRequest - 交換要求の詳細。交換するトークンまたは交換する URI。

Returns:

CompleteableFuture が完了すると、交換されたトークンが返されます。

getAadTokens

public abstract CompletableFuture<>> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

カスタマイズされた AppCredentials を使用して、構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

connectionName - このボットで構成された Azure Active Directory 接続の名前。

resourceUrls - トークンを取得するリソース URL の一覧。

userId - トークンを取得するユーザー ID。 null を渡すと、UserId は TurnContext のアクティビティから取得されます。

Returns:

対応する TokenResponse への resourceUrl の Dictionary。

getAadTokens

public default CompletableFuture<>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - このボットで構成された Azure Active Directory 接続の名前。

resourceUrls - トークンを取得するリソース URL の一覧。

Returns:

対応する TokenResponse への resourceUrl の Dictionary。

getAadTokens

public abstract CompletableFuture<>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

構成された接続上の特定のリソースの Azure Active Directory トークンを取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

connectionName - このボットで構成された Azure Active Directory 接続の名前。

resourceUrls - トークンを取得するリソース URL の一覧。

userId - トークンを取得するユーザー ID。 null を渡す場合、userId は ITurnContext のアクティビティから取得されます。

Returns:

対応する TokenResponse への resourceUrl の Dictionary。

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

カスタマイズされた AppCredentials を使用して、接続名のサインイン用にユーザーに送信される未加工のサインイン リンクを取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

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

Returns:

実行するキューに登録されている作業を表す CompletableFuture。 CompleteableFuture が正常に完了すると、結果には生のサインイン リンクが含まれます。

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

カスタマイズされた AppCredentials を使用して、接続名のサインイン用にユーザーに送信される未加工のサインイン リンクを取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

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

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

finalRedirect - OAuth フローがリダイレクトする最後の URL。

Returns:

実行するキューに登録されている作業を表す CompletableFuture。 CompleteableFuture が正常に完了すると、結果には生のサインイン リンクが含まれます。

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

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

Returns:

実行するキューに登録された作業を表すタスク。 タスクが正常に完了すると、結果に生のサインイン リンクが含まれます。

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

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

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

finalRedirect - OAuth フローがリダイレクトする最後の URL。

Returns:

実行するキューに登録された作業を表すタスク。 タスクが正常に完了すると、結果に生のサインイン リンクが含まれます。

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の資格情報。

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

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

finalRedirect - OAuth フローがリダイレクトする最後の URL。

Returns:

実行するキューに登録された作業を表す CompletableFuture。 CompleteableFuture が正常に完了すると、結果には生のサインイン リンクが含まれます。

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

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

Returns:

実行するキューに登録された作業を表す CompletableFuture。 CompleteableFuture が正常に完了すると、結果には生のサインイン リンクが含まれます。

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

接続名のサインインのためにユーザーに送信される未加工のサインイン リンクを取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

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

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

finalRedirect - OAuth フローがリダイレクトする最後の URL。

Returns:

実行するキューに登録された作業を表す CompletableFuture。 CompleteableFuture が正常に完了すると、結果には生のサインイン リンクが含まれます。

getTokenStatus

public abstract CompletableFuture<>> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

カスタマイズされた AppCredentials を使用して、特定のユーザーに対して構成された各接続のトークンの状態を取得します。

Parameters:

context - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

userId - トークンの状態が取得されるユーザー ID。

includeFilter - 含める接続のコンマ区切りリスト (省略可能)。 空白にすると、構成されているすべての接続のトークンの状態が返されます。

Returns:

TokenStatus の配列。

getTokenStatus

public default CompletableFuture<>> getTokenStatus(TurnContext turnContext, String userId)

特定のユーザーに対して構成された各接続のトークンの状態を取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

userId - トークンの状態が取得されるユーザー ID。

Returns:

TokenStatus の配列。

getTokenStatus

public abstract CompletableFuture<>> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

特定のユーザーに対して構成された各接続のトークンの状態を取得します。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

userId - トークンの状態が取得されるユーザー ID。

includeFilter - 含める接続のコンマ区切りリスト。 空白にすると、構成されているすべての接続のトークンの状態が返されます。

Returns:

TokenStatus の配列。

getUserToken

public abstract CompletableFuture getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

カスタマイズされた AppCredentials を使用して、ログイン フロー内のユーザーのトークンを取得しようとします。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

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

magicCode - (省略可能)省略可能なユーザーが検証するコードを入力しました。

Returns:

トークン応答。

getUserToken

public abstract CompletableFuture getUserToken(TurnContext turnContext, String connectionName, String magicCode)

ログイン フロー内のユーザーのトークンの取得を試みます。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

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

magicCode - (省略可能)省略可能なユーザーが検証するコードを入力しました。

Returns:

トークン応答。

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

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

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

Returns:

実行するキューに登録された作業を表すタスク。

signOutUser

public abstract CompletableFuture signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

カスタマイズされた AppCredentials を使用して、トークン サーバーを使用してユーザーをサインアウトします。

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

oAuthAppCredentials - OAuth の AppCredentials。

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

userId - サインアウトするユーザーのユーザー ID。

Returns:

実行するキューに登録された作業を表す CompletableFuture。

signOutUser

public abstract CompletableFuture signOutUser(TurnContext turnContext, String connectionName, String userId)

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

Parameters:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。

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

userId - サインアウトするユーザーのユーザー ID。

Returns:

実行するキューに登録された作業を表すタスク。