更新 authenticationEventListener

命名空间:microsoft.graph

更新 authenticationEventListener 对象的属性。 必须指定要更新的 @odata.type 属性和 authenticationEventListener 对象类型的值。 当前支持以下派生类型。

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

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

权限

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

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

重要

在具有工作或学校帐户的委派方案中,必须为管理员分配受支持的Microsoft Entra角色或具有受支持角色权限的自定义角色。 此作支持以下最低特权角色:

  • 身份验证扩展性管理员
  • 应用程序管理员

HTTP 请求

PATCH /identity/authenticationEventListeners/{authenticationEventListenerId}

请求标头

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

请求正文

在请求正文中, 提供要更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。

下表指定可更新的属性。

必须指定要更新的 @odata.type 属性和 authenticationEventListener 对象类型的值。 例如,"@odata.type": "#microsoft.graph.onTokenIssuanceStartListener"

属性 类型 说明
conditions authenticationConditions 此 authenticationEventListener 应触发的条件。 可选。
displayName String 身份验证事件侦听器策略的显示名称。 可选。
Handler onTokenIssuanceStartHandler | onFraudProtectionLoadStartHandler 满足条件时要调用的处理程序。 处理程序的类型取决于侦听器类型:
- 对于 onTokenIssuanceStartListener,请使用 onTokenIssuanceStartHandler
- 对于 onFraudProtectionLoadStartListener,请使用 onFraudProtectionLoadStartHandler

响应

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

示例

示例 1:更新身份验证事件侦听器的触发条件

请求

以下示例显示了更新身份验证事件侦听器的触发条件的请求。

PATCH https://graph.microsoft.com/v1.0/identity/authenticationEventListeners/990d94e5-cc8f-4c4b-97b4-27e2678aac28
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",
    "conditions": {
        "applications": {
            "includeApplications": [
                {
                    "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4"
                }
            ]
        }
    },
}

响应

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

HTTP/1.1 204 No Content

示例 2:将应用程序添加到身份验证事件侦听器的触发条件

请求

以下示例演示了将应用程序添加到身份验证事件侦听器的触发条件的请求。

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners/0313cc37-d421-421d-857b-87804d61e33e/conditions/applications/includeApplications
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.authenticationConditionApplication",
    "appId": "63856651-13d9-4784-9abf-20758d509e19"
}

响应

以下示例显示了对将应用程序添加到身份验证事件侦听器的触发条件的请求的响应:

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners('0313cc37-d421-421d-857b-87804d61e33e')/conditions/applications/includeApplications/$entity",
    "appId": "63856651-13d9-4784-9abf-20758d509e19"
}