教程:在 Microsoft 标识平台注册 Web API
本教程介绍如何在 Microsoft Entra ID 租户中注册 Web API。 必须在 Microsoft Entra 管理中心注册应用程序,使应用程序能够与 Microsoft 标识平台进行交互。 在本文中;
- 在租户中注册 Web API
- 记录 Web API 的唯一标识符
- 通过添加范围公开 API
先决条件
- 具有活动订阅的 Azure 帐户。 创建帐户。
- Azure 帐户必须拥有管理应用程序的权限。 使用注册应用程序所需的以下任何角色:
- 应用程序管理员
- 应用程序开发人员
- 云应用程序管理员
注册应用程序和记录标识符
提示
本文中的步骤可能因开始使用的门户而略有不同。
若要完成注册,请为应用程序命名并指定支持的帐户类型。 注册后,应用程序概述页将显示应用程序源代码中所需的标识符。
至少以应用程序开发人员的身份登录到 Microsoft Entra 管理中心。
如果你有权访问多个租户,请使用顶部菜单中的“设置”图标 ,通过“目录 + 订阅”菜单切换到你希望在其中注册应用程序的租户。
浏览到“标识”>“应用程序”>“应用注册”。
选择“新注册”。
为应用程序输入名称,例如 NewWebAPI1。
对于“支持的帐户类型”设置,请选择“仅限此组织目录中的帐户”。 要了解不同帐户类型的信息,选择“帮我选择”选项。
选择“注册”。
注册完成后,将显示应用程序的“概述”窗格。 记录要用于应用程序源代码的目录(租户)ID 和应用程序(客户端)ID。
注意
可以通过参照修改应用程序支持的帐户来更改支持的帐户类型。
公开 API
注册 API 后,可以通过定义 API 公开给客户端应用程序的范围来配置其权限。 客户端应用程序通过将访问令牌及其请求传递到受保护的 Web API 来请求执行操作的权限。 然后,仅当 Web API 接收的访问令牌包含所需范围时,Web API 才会执行请求的操作。
在“管理”下,选择“公开 API > 添加范围”。 选择“保存并继续”,以接受建议的应用程序 ID URI
(api://{clientId})
。{clientId}
将是从“概述”页记录的值。 然后输入以下信息:- 对于“范围名称”,输入
Forecast.Read
。 - 对于“谁能同意?”,请确保选择了“管理员和用户”选项。
- 在“管理员同意显示名称”框中,输入
Read forecast data
。 - 在“管理员同意说明”框中,输入
Allows the application to read weather forecast data
。 - 在“用户同意显示名称”框中,输入
Read forecast data
。 - 在“用户同意说明”框中,输入
Allows the application to read weather forecast data
。 - 确保将“状态”设置为“已启用”。
- 对于“范围名称”,输入
选择“添加作用域”。 如果已正确输入范围,则会在“公开 API”窗格中列出该范围。