UserTokenProvider 接口

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)

执行令牌交换操作,例如单一登录。

参数:

turnContext - 与用户的当前会话轮次的上下文。
oAuthAppCredentials - 适用于 OAuth 的 AppCredentials。
connectionName - 要使用的身份验证连接的名称。
userId - 与 token 关联的用户 ID。
exchangeRequest - 交换请求详细信息,可以是要交换的令牌,要么是交换的 URI。

返回:

如果 CompleteableFuture 完成,则返回交换的令牌。

exchangeToken

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

执行令牌交换操作,例如单一登录。

参数:

turnContext - 与用户的当前会话轮次的上下文。
connectionName - 要使用的身份验证连接的名称。
userId - 与 token 关联的用户 ID。
exchangeRequest - 交换请求详细信息,可以是要交换的令牌,要么是交换的 URI。

返回:

如果 CompleteableFuture 完成,则返回交换的令牌。

getAadTokens

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

使用自定义的 AppCredentials 检索配置连接上特定资源的 Azure Active Directory 令牌。

参数:

context - 与用户的当前会话轮次的上下文。
oAuthAppCredentials - 适用于 OAuth 的 AppCredentials。
connectionName - 使用此机器人配置的 Azure Active Directory 连接的名称。
resourceUrls - 要为其检索令牌的资源 URL 列表。
userId - 检索令牌的用户 ID。 如果传入 null,则 userId 将从 TurnContext 中的活动获取。

返回:

resourceUrl 字典到相应的 TokenResponse。

getAadTokens

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

检索配置连接上特定资源的 Azure Active Directory 令牌。

参数:

turnContext - 与用户的当前会话轮次的上下文。
connectionName - 使用此机器人配置的 Azure Active Directory 连接的名称。
resourceUrls - 要为其检索令牌的资源 URL 列表。

返回:

resourceUrl 字典到相应的 TokenResponse。

getAadTokens

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

检索配置连接上特定资源的 Azure Active Directory 令牌。

参数:

turnContext - 与用户的当前会话轮次的上下文。
connectionName - 使用此机器人配置的 Azure Active Directory 连接的名称。
resourceUrls - 要为其检索令牌的资源 URL 列表。
userId - 检索令牌的用户 ID。 如果传入 null,则将从 ITurnContext 中的 Activity 获取 userId。

返回:

resourceUrl 字典到相应的 TokenResponse。

getOAuthSignInLink

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

使用自定义的 AppCredentials 获取要发送给用户以登录的连接名称的原始登录链接。

参数:

turnContext - 与用户的当前会话轮次的上下文。
oAuthAppCredentials - 适用于 OAuth 的 AppCredentials。
connectionName - 要使用的身份验证连接的名称。

返回:

表示要执行的工作的 CompletableFuture。 如果 CompleteableFuture 成功完成,则结果包含原始登录链接。

getOAuthSignInLink

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

使用自定义的 AppCredentials 获取要发送给用户以登录的连接名称的原始登录链接。

参数:

turnContext - 与用户的当前会话轮次的上下文。
oAuthAppCredentials - 适用于 OAuth 的 AppCredentials。
connectionName - 要使用的身份验证连接的名称。
userId - 将与令牌关联的用户 ID。
finalRedirect - OAuth 流将重定向到的最终 URL。

返回:

表示要执行的工作的 CompletableFuture。 如果 CompleteableFuture 成功完成,则结果包含原始登录链接。

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

turnContext - 与用户的当前会话轮次的上下文。
connectionName - 要使用的身份验证连接的名称。

返回:

表示要执行的工作的任务。 如果任务成功完成,则结果包含原始登录链接。

getOAuthSignInLink

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

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

turnContext - 与用户的当前会话轮次的上下文。
connectionName - 要使用的身份验证连接的名称。
userId - 将与令牌关联的用户 ID。
finalRedirect - OAuth 流将重定向到的最终 URL。

返回:

表示要执行的工作的任务。 如果任务成功完成,则结果包含原始登录链接。

getSignInResource

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

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

turnContext - 与用户的当前会话轮次的上下文。
oAuthAppCredentials - OAuth 的凭据。
connectionName - 要使用的身份验证连接的名称。
userId - 将与令牌关联的用户 ID。
finalRedirect - OAuth 流将重定向到的最终 URL。

返回:

表示要执行的工作的 CompletableFuture。 如果 CompleteableFuture 成功完成,则结果包含原始登录链接。

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

turnContext - 与用户的当前会话轮次的上下文。
connectionName - 要使用的身份验证连接的名称。

返回:

表示要执行的工作的 CompletableFuture。 如果 CompleteableFuture 成功完成,则结果包含原始登录链接。

getSignInResource

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

获取要发送给用户用于登录的连接名称的原始登录链接。

参数:

turnContext - 与用户的当前会话轮次的上下文。
connectionName - 要使用的身份验证连接的名称。
userId - 将与令牌关联的用户 ID。
finalRedirect - OAuth 流将重定向到的最终 URL。

返回:

表示要执行的工作的 CompletableFuture。 如果 CompleteableFuture 成功完成,则结果包含原始登录链接。

getTokenStatus

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

使用自定义的 AppCredentials 检索给定用户的每个已配置连接的令牌状态。

参数:

context - 与用户的当前会话轮次的上下文。
oAuthAppCredentials - 适用于 OAuth 的 AppCredentials。
userId - 检索令牌状态的用户 ID。
includeFilter - 要包含的连接的可选逗号分隔列表。 空白将返回所有已配置连接的令牌状态。

返回:

TokenStatus 数组。

getTokenStatus

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

检索给定用户的每个已配置连接的令牌状态。

参数:

turnContext - 与用户的当前会话轮次的上下文。
userId - 检索令牌状态的用户 ID。

返回:

TokenStatus 数组。

getTokenStatus

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

检索给定用户的每个已配置连接的令牌状态。

参数:

turnContext - 与用户的当前会话轮次的上下文。
userId - 检索令牌状态的用户 ID。
includeFilter - 要包含的连接的逗号分隔列表。 空白将返回所有已配置连接的令牌状态。

返回:

TokenStatus 数组。

getUserToken

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

尝试使用自定义的 AppCredentials 检索登录流中的用户的令牌。

参数:

turnContext - 与用户的当前会话轮次的上下文。
oAuthAppCredentials - 适用于 OAuth 的 AppCredentials。
connectionName - 要使用的身份验证连接的名称。
magicCode - (可选)可选用户输入代码进行验证。

返回:

令牌响应。

getUserToken

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

尝试检索登录流中的用户的令牌。

参数:

turnContext - 与用户的当前会话轮次的上下文。
connectionName - 要使用的身份验证连接的名称。
magicCode - (可选)可选用户输入代码进行验证。

返回:

令牌响应。

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

使用令牌服务器注销用户。

参数:

turnContext - 与用户的当前会话轮次的上下文。

返回:

表示要执行的工作的任务。

signOutUser

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

使用自定义 AppCredentials 通过令牌服务器注销用户。

参数:

turnContext - 与用户的当前会话轮次的上下文。
oAuthAppCredentials - 适用于 OAuth 的 AppCredentials。
connectionName - 要使用的身份验证连接的名称。
userId - 要注销的用户的用户 ID。

返回:

表示要执行的工作的 CompletableFuture。

signOutUser

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

使用令牌服务器注销用户。

参数:

turnContext - 与用户的当前会话轮次的上下文。
connectionName - 要使用的身份验证连接的名称。
userId - 要注销的用户的用户 ID。

返回:

表示要执行的工作的任务。

适用于