创建 authenticationEventListener

命名空间:microsoft.graph

创建新的 authenticationEventListener 对象。 可以创建派生自 authenticationEventListener 的以下子类型之一。

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

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

权限

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

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

重要

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

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

HTTP 请求

POST /identity/authenticationEventListeners

请求标头

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

请求正文

在请求正文中,提供 authenticationEventListener 对象的 JSON 表示形式。

创建 authenticationEventListener 时,可以指定以下属性。 必须指定 @odata.type 属性才能指定要创建的 authenticationEventListener 的类型;例如 。 @odata.type": "microsoft.graph.onTokenIssuanceStartListener"

属性 类型 说明
conditions authenticationConditions 此 authenticationEventListener 应触发的条件。 可选。
Handler onTokenIssuanceStartHandler 满足条件时要调用的处理程序。 可以为 onTokenIssuanceStartListener 侦听器类型设置。

响应

如果成功,此方法在 201 Created 响应正文中返回响应代码和 authenticationEventListener 对象。 @odata.type 属性指定所创建对象的类型。

示例

请求

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

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json
Content-length: 312

{
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",
    "conditions": {
        "applications": {
            "includeApplications": [
                {
                    "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4"
                }
            ]
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler",
        "customExtension": {
            "id": "6fc5012e-7665-43d6-9708-4370863f4e6e"
        }
    }
}

响应

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

注意:为了提高可读性,可能缩短了此处显示的响应对象。

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",
    "id": "990d94e5-cc8f-4c4b-97b4-27e2678aac28",
    "conditions": {
        "applications": {
            "includeApplications": [
                {
                    "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4"
                }
            ]
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler",
        "customExtension": {
            "id": "6fc5012e-7665-43d6-9708-4370863f4e6e"
        }
    }
}