更新 apiConnectorConfiguration

命名空间:microsoft.graph

更新 b2xIdentityUserFlow 中的 apiConnectorConfiguration 属性,以在用户流中启用或禁用 API 连接器。 apiConnectorConfiguration 的每个关系都对应于用户流中的一个特定步骤,该步骤可以配置为调用 API 连接器。 一次为特定步骤 1 配置 API 连接器,如下所示。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) IdentityUserFlow.ReadWrite.All 不可用。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 IdentityUserFlow.ReadWrite.All 不可用。

重要

在具有工作或学校帐户的委托方案中,必须为登录用户分配受支持的Microsoft Entra角色或具有支持的角色权限的自定义角色。 外部 ID用户流管理员是此操作支持的最低特权角色。

HTTP 请求

PUT /identity/b2xUserFlows/{b2xUserFlowId}/apiConnectorConfiguration/{step}/$ref

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。

请求正文

在请求正文中,提供要使用的特定步骤的 identityApiConnector 的 JSON 表示形式id。 若要禁用 API 连接器,该值可以为 {}。

响应

如果成功,此方法返回 204 No Content 响应代码。

示例

示例 1:为注册后 IDP 联合身份验证启用 API 连接器

请求

以下示例显示了一个请求。

PUT https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_testuserflow/apiConnectorConfiguration/postFederationSignup/$ref
Content-Type: application/json

{
    "@odata.id": "https://graph.microsoft.com/v1.0/identity/apiConnectors/{id}"   
}

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content

示例 2:在注册时为 Post 属性集合启用 API 连接器

请求

以下示例显示了一个请求。

PUT https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_testuserflow/apiConnectorConfiguration/postAttributeCollection/$ref
Content-Type: application/json

{
    "@odata.id": "https://graph.microsoft.com/v1.0/identity/apiConnectors/{id}"   
}

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content

示例 3:在注册时禁用用于 Post 属性集合的 API 连接器

请求

以下示例显示了一个请求。

PUT https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_testuserflow/apiConnectorConfiguration/postAttributeCollection/$ref
Content-Type: application/json

{ }

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content