适用于: AD FS 2019 及更高版本
了解如何生成代表用户调用另一个 Web API 的 Web API。
阅读本文之前,应熟悉 AD FS 概念 和 Behalf_Of 流
概述
-
(Web 应用) 的客户端(不在下图中表示)-调用受保护的 Web API 并在其 "Authorization" Http 标头中提供 JWT 持有者令牌。
-
受保护的 Web API 将验证令牌,并使用 MSAL AcquireTokenOnBehalfOf 方法请求 AD FS) 另一个令牌的 (,以便它本身能够代表用户调用名为下游 web api) 的第二个 web (api。
-
受保护的 Web API 使用此令牌调用下游 API。 它还可以调用 AcquireTokenSilentlater 来请求其他下游 Api (的令牌,但仍代表相同的用户) 。AcquireTokenSilent 在需要时刷新该令牌。
概览
为了更好地了解如何在 ADFS 中代表身份验证方案进行配置,我们使用 此处 提供的示例并演练应用注册和代码配置步骤。
先决条件
- GitHub 客户端工具
- AD FS 2019 或更高版本配置并运行
- Visual Studio 2013 或更高版本
AD FS 中的应用注册
本部分演示如何将本机应用作为公共客户端和 Web Api 注册为依赖方 (RP) 在 AD FS
-
在 AD FS 管理 "中,右键单击" 应用程序组 ",然后选择" 添加应用程序组"。
-
在应用程序组向导上,为 " 输入 WebApiToWebApi ",在 " 客户端-服务器应用程序 " 下,选择 本机应用程序访问 Web API 模板。 单击“下一步” 。
"添加应用程序组向导" 的 "欢迎使用" 页的屏幕截图,其中突出显示了访问 Web API 模板的本机应用程序。
-
复制 " 客户端标识符 " 值。 稍后会将其用作应用程序 App.config 文件中的 ClientId 值。 对于 "重定向 URI",请输入以下内容: - https://ToDoListClient 。 单击 “添加” 。 单击“下一步” 。
"添加应用程序组向导" 的 "本机应用程序" 页的屏幕截图,显示 "重定向 U R I"。
-
在 "配置 Web API" 屏幕上,输入 标识符: https://localhost:44321/ 。 单击 “添加” 。 单击“下一步” 。 稍后将在应用程序的 App.config 和 Web.Config 文件中使用此值。
"添加应用程序组" 向导的 "配置 Web API" 页的屏幕截图,其中显示了正确的标识符。
-
在 "应用访问控制策略" 屏幕上,选择 " 允许每个人 " 并单击 " 下一步"
"添加应用程序组向导" 的 "选择访问控制策略" 页的屏幕截图,显示突出显示 "允许所有人" 选项。
-
在 "配置应用程序权限" 屏幕上,选择 " openid and user_impersonation"。 单击“下一步” 。
"添加应用程序组" 向导的 "配置应用程序权限" 页的屏幕截图,其中显示了 "已选择"
-
在 "摘要" 屏幕上,单击 " 下一步"。
-
在 "完成" 屏幕上,单击 " 关闭"。
-
在 AD FS 管理 "中,单击" 应用程序组 ",并选择" WebApiToWebApi 应用程序组 "。 右键单击并选择 “属性”。
显示突出显示 "WebApiToWebApi" 组的 "D F S 管理" 对话框的屏幕截图,并显示下拉列表中的 "属性" 选项。
-
在 WebApiToWebApi 属性屏幕上,单击 " 添加应用程序 ..."。
WebApiToWebApi "属性" 对话框的屏幕截图,其中列出了列出的 WebApiToWebApi A P 应用程序。
-
在 "独立应用程序" 下,选择 " 服务器应用程序"。
"添加新应用程序到 WebApiToWebApi" 向导的 "欢迎" 页的屏幕截图,其中突出显示了 "服务器应用程序" 选项。
-
在 "服务器应用程序" 屏幕上,添加 https://localhost:44321/ 作为 客户端标识符 和 重定向 URI。
"向 WebApiToWebApi 中添加新应用程序" 向导的 "服务器应用程序" 页的屏幕截图,其中显示了正确的客户端标识符和重定向 U R I。
-
在 "配置应用程序凭据" 屏幕上,选择 " 生成共享机密"。 复制该机密供以后使用。
"将新应用程序添加到 WebApiToWebApi" 向导的 "配置应用程序凭据应用程序" 页的屏幕截图,其中显示了 "生成共享机密" 选项,并且突出显示了生成的共享机密。
-
在 "摘要" 屏幕上,单击 " 下一步"。
-
在 "完成" 屏幕上,单击 " 关闭"。
-
在 AD FS 管理 "中,单击" 应用程序组 ",并选择" WebApiToWebApi 应用程序组 "。 右键单击并选择 “属性”。
显示 WebApiToWebApi 组突出显示的 "D F S 管理" 对话框的第二个屏幕截图,并显示下拉列表中的 "属性" 选项。
-
在 WebApiToWebApi 属性屏幕上,单击 " 添加应用程序 ..."。
"WebApiToWebApi 属性" 对话框的第二个屏幕截图,其中列出了列出的 WebApiToWebApi A P 应用程序。
-
在 "独立应用程序" 下,选择 " WEB API"。
"添加新应用程序到 WebApiToWebApi" 向导的 "欢迎" 页的屏幕截图,其中突出显示了 "Web A P I" 选项。
-
在 "配置 Web API" 上,添加 https://localhost:44300 作为 标识符。
"向 WebApiToWebApi 中添加新应用程序" 向导的 "配置 Web A P I" 页的屏幕截图,其中显示了正确的重定向 U R I。
-
在 "应用访问控制策略" 屏幕上,选择 " 允许每个人 " 并单击 " 下一步"
用于显示 "允许所有人" 选项突出显示的 "选择访问控制策略" 页的屏幕截图。
-
在 "配置应用程序权限" 屏幕上,单击 " 下一步"。
"向 WebApiToWebApi 中添加新应用程序" 向导的 "配置应用程序权限" 页的屏幕截图,其中显示了下一个选项。
-
在 "摘要" 屏幕上,单击 " 下一步"。
-
在 "完成" 屏幕上,单击 " 关闭"。
-
在 WebApiToWebApi 上单击 "确定" – Web API 2 属性屏幕
-
在 WebApiToWebApi 的 "属性" 屏幕上,选择 " WebApiToWebApi – WEB API ",然后单击 " 编辑 ..."。
显示 "WebApiToWebApi 属性" 对话框的屏幕截图,其中突出显示了 P I 应用程序 WebApiToWebApi。
-
在 "WebApiToWebApi – Web API 属性" 屏幕上,选择 " 颁发转换规则 " 选项卡,然后单击 " 添加规则 ..."。
显示 "颁发转换规则" 选项卡的 "WebApiToWebApi-Web A P I 属性" 对话框的屏幕截图。
-
在 "添加转换声明规则向导" 上,选择 " 使用自定义规则发送声明 ",然后单击 " 下一步"。
"添加转换声明规则向导" 的 "选择规则模板" 页的屏幕截图,其中选择了 "使用自定义规则发送声明" 选项。
-
在 声明规则名称: 字段和 x: [] => 发出 (声明 = x) ; 声明规则在自定义规则:字段中输入 PassAllClaims ,然后单击 "完成"。
"添加转换声明规则" 向导的 "配置规则" 页的屏幕截图,其中显示了上面所述的配置。
-
单击 "WebApiToWebApi – Web API 属性" 屏幕上的 "确定"
-
在 WebApiToWebApi 的 "属性" 屏幕上,选择 "选择 WebApiToWebApi – Web API 2",然后单击 "编辑 ..." 显示 WebApiToWebApi A P I 2 应用程序的 "WebApiToWebApi 属性" 对话框的屏幕截图。
-
在 "WebApiToWebApi – Web API 2 属性" 屏幕上,选择 "颁发转换规则" 选项卡,然后单击 "添加规则 ..."
-
在 "添加转换声明规则向导" 上,从下拉列表中选择 "使用自定义规则发送声明",然后单击 "添加转换声明规则向导" 的 "选择规则模板" 页的 "选择规则模板" 页的 "选择规则模板"
-
在声明规则名称:字段和 x: [] => 发出 (声明 = x) ; 声明规则在 自定义规则: 字段中输入 PassAllClaims,然后单击 " 完成"。
"添加转换声明规则" 向导的 "配置规则" 页的第二个屏幕截图,其中显示了上面所述的配置。
-
单击 "WebApiToWebApi – Web API 2 属性" 屏幕上的 "确定",然后单击 "WebApiToWebApi 属性" 屏幕。
代码配置
本部分演示如何将 Web API 配置为调用另一个 Web API
-
从此处下载示例
-
使用 Visual Studio 打开示例
-
打开 App.config 文件。 修改以下内容:
-
ida:颁发机构-输入 https://[你的 AD FS 主机名]/adfs/
-
ida: ClientId-在上面 AD FS 部分的 "应用注册 #3 中输入值。
-
ida: RedirectUri-在上述 AD FS 部分中输入应用注册 #3 的值。
-
todo: TodoListResourceId –在上述 AD FS 部分的 "应用注册" 中 #4 输入标识符值
-
ida: todo: TodoListBaseAddress-在上述 AD FS 部分的 "应用注册 #4 中输入标识符值。
显示修改后的值的应用程序配置文件的屏幕截图。
-
-
打开 ToDoListService 下的 Web.config 文件。 修改以下内容:
-
ida:受众-在上 AD FS 部分的应用注册中输入客户端标识符值 #12
-
ida: ClientId-在上 AD FS 部分的 "应用注册 #12 中输入客户端标识符值。
-
Ida: ClientSecret-在上述 AD FS 部分中输入从应用注册 #13 复制的共享机密。
-
ida: RedirectUri-在上面 AD FS 部分的 "应用注册 #12 中输入 RedirectUri 值。
-
ida: AdfsMetadataEndpoint-输入 https://[你的 AD FS 主机名]/federationmetadata/2007-06/federationmetadata.xml
-
ida: OBOWebAPIBase-在上面 AD FS 部分的 "应用注册 #19 中输入标识符值。
-
ida:颁发机构-输入 https://[你的 AD FS 主机名]/adfs
ToDoListService 下的 web 配置文件的屏幕截图,其中显示了修改后的值。
-
-
打开 WebAPIOBO 下的 Web.config 文件。 修改以下内容:
-
ida: AdfsMetadataEndpoint-输入 https://[你的 AD FS 主机名]/federationmetadata/2007-06/federationmetadata.xml
-
ida:受众-在上 AD FS 部分的应用注册中输入客户端标识符值 #12
WebAPIOBO 下的 web 配置文件的屏幕截图,其中显示了修改后的值。
-
测试示例
本部分介绍如何测试上面配置的示例。
更改代码后,重新生成解决方案
-
在 Visual Studio 上,右键单击 "解决方案",然后选择 "设置启动项目 ... "
突出显示 "设置启动项目" 选项时显示的列表屏幕截图。
-
在 "属性页" 中,请确保将每个项目的 " 操作 " 设置为 " 启动 ",TodoListSPA 除外。
"解决方案属性页" 对话框的屏幕截图,其中显示了 "多启动项目" 选项和所有项目的 "操作" 设置为 "启动"。
-
在 Visual Studio 顶部,单击绿色箭头。
Visual Studio UI 的屏幕截图,其中的 Start 选项称为 "out"。
-
在本机应用程序的主屏幕上,单击 " 登录"。
"待办事项列表客户端" 对话框的屏幕截图。
如果看不到 "本机应用" 屏幕,请在系统上的项目存储库保存到的文件夹中搜索和删除 * msalcache 文件。
-
你将被重定向到 AD FS 登录页。 继续登录。
登录页的屏幕截图。
-
登录后,在 "创建待办事项" 项 中的 "Web api 调用" 中输入文本 web api。 单击 " 添加项"。 这会调用 Web API (待办事项列表服务,) 随后会调用 Web API 2 (WebAPIOBO) 并将该项添加到缓存中。
"待办事项列表客户端" 对话框的屏幕截图,其中包含 "待办事项" 项。
后续步骤
AD FS OpenID Connect/OAuth 流和应用程序方案
历史资料。此文对应 2021-03-23 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 billmath)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
