ExtendedUserTokenProvider 类

继承

UserTokenProvider

ExtendedUserTokenProvider

ABC

ExtendedUserTokenProvider

构造函数

ExtendedUserTokenProvider()

方法

exchange_token	执行令牌交换操作，例如进行单一登录。
exchange_token_from_credentials	执行令牌交换操作，例如进行单一登录。
get_aad_tokens	检索已配置连接上特定资源的 Azure Active Directory 令牌。 :p aram context： :p aram connection_name： :p aram resource_urls： :p aram user_id： :p aram oauth_app_credentials： ：return：
get_oauth_sign_in_link	获取要发送给用户的原始登录链接，以便用户登录连接名称。 :p aram context： :p aram connection_name： :p aram final_redirect： :p aram oauth_app_credentials： ：return：
get_sign_in_resource	获取要发送给用户的原始登录链接，以便用户登录连接名称。
get_sign_in_resource_from_user	获取要发送给用户的原始登录链接，以便用户登录连接名称。
get_sign_in_resource_from_user_and_credentials	获取要发送给用户的原始登录链接，以便用户登录连接名称。
get_user_token	检索登录流中的用户的 OAuth 令牌。 :p aram context： :p aram connection_name： :p aram magic_code： :p aram oauth_app_credentials： ：return：
sign_out_user	使用令牌服务器注销用户。 :p aram context： :p aram connection_name： :p aram user_id： :p aram oauth_app_credentials： ：return：

exchange_token

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

async exchange_token(turn_context: TurnContext, connection_name: str, user_id: str, exchange_request: TokenExchangeRequest) -> TokenResponse

参数

名称	说明
turn_context 必需	与用户当前轮次聊天的上下文。
connection_name 必需	要使用的身份验证连接的名称。
user_id 必需	与令牌关联的用户 ID。
exchange_request 必需	交换请求详细信息，要交换的令牌或要交换的 URI。

返回

类型	说明
	如果任务完成，则返回交换的令牌。

exchange_token_from_credentials

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

async exchange_token_from_credentials(turn_context: TurnContext, oauth_app_credentials: AppCredentials, connection_name: str, user_id: str, exchange_request: TokenExchangeRequest) -> TokenResponse

参数

名称	说明
turn_context 必需	与用户当前轮次聊天的上下文。
oauth_app_credentials 必需	适用于 OAuth 的 AppCredentials。
connection_name 必需	要使用的身份验证连接的名称。
user_id 必需	与令牌关联的用户 ID。
exchange_request 必需	交换请求详细信息，要交换的令牌或要交换的 URI。

返回

类型	说明
	如果任务完成，则返回交换的令牌。

get_aad_tokens

检索已配置连接上特定资源的 Azure Active Directory 令牌。 :p aram context： :p aram connection_name： :p aram resource_urls： :p aram user_id： :p aram oauth_app_credentials： ：return：

async get_aad_tokens(context: TurnContext, connection_name: str, resource_urls: List[str], user_id: str = None, oauth_app_credentials: AppCredentials = None) -> Dict[str, TokenResponse]

参数

名称	说明
context 必需
connection_name 必需
resource_urls 必需
user_id	默认值: None
oauth_app_credentials	默认值: None

get_oauth_sign_in_link

获取要发送给用户的原始登录链接，以便用户登录连接名称。 :p aram context： :p aram connection_name： :p aram final_redirect： :p aram oauth_app_credentials： ：return：

async get_oauth_sign_in_link(context: TurnContext, connection_name: str, final_redirect: str = None, oauth_app_credentials: AppCredentials = None) -> str

参数

名称	说明
context 必需
connection_name 必需
final_redirect	默认值: None
oauth_app_credentials	默认值: None

get_sign_in_resource

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

async get_sign_in_resource(turn_context: TurnContext, connection_name: str) -> SignInUrlResponse

参数

名称	说明
turn_context 必需	与用户当前轮次聊天的上下文。
connection_name 必需	要使用的身份验证连接的名称。

返回

类型	说明
	表示排队等待执行的工作的任务。

注解

如果任务成功完成，则结果包含原始登录链接。

get_sign_in_resource_from_user

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

async get_sign_in_resource_from_user(turn_context: TurnContext, connection_name: str, user_id: str, final_redirect: str = None) -> SignInUrlResponse

参数

名称	说明
turn_context 必需	与用户当前轮次聊天的上下文。
connection_name 必需	要使用的身份验证连接的名称。
user_id 必需	将与令牌关联的用户 ID。
final_redirect	OAuth 流将重定向到的最终 URL。 默认值: None

返回

类型	说明
	表示排队等待执行的工作的任务。

注解

如果任务成功完成，则结果包含原始登录链接。

get_sign_in_resource_from_user_and_credentials

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

async get_sign_in_resource_from_user_and_credentials(turn_context: TurnContext, oauth_app_credentials: AppCredentials, connection_name: str, user_id: str, final_redirect: str = None) -> SignInUrlResponse

参数

名称	说明
turn_context 必需	与用户当前轮次聊天的上下文。
oauth_app_credentials 必需	OAuth 的凭据。
connection_name 必需	要使用的身份验证连接的名称。
user_id 必需	将与令牌关联的用户 ID。
final_redirect	OAuth 流将重定向到的最终 URL。 默认值: None

返回

类型	说明
	表示排队等待执行的工作的任务。

注解

如果任务成功完成，则结果包含原始登录链接。

get_user_token

检索登录流中的用户的 OAuth 令牌。 :p aram context： :p aram connection_name： :p aram magic_code： :p aram oauth_app_credentials： ：return：

async get_user_token(context: TurnContext, connection_name: str, magic_code: str = None, oauth_app_credentials: AppCredentials = None) -> TokenResponse

参数

名称	说明
context 必需
connection_name 必需
magic_code	默认值: None
oauth_app_credentials	默认值: None

sign_out_user

使用令牌服务器注销用户。 :p aram context： :p aram connection_name： :p aram user_id： :p aram oauth_app_credentials： ：return：

async sign_out_user(context: TurnContext, connection_name: str = None, user_id: str = None, oauth_app_credentials: AppCredentials = None)

参数

名称	说明
context 必需
connection_name	默认值: None
user_id	默认值: None
oauth_app_credentials	默认值: None