Edit

Create authenticationEventListener

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new authenticationEventListener object. You can create one of the following subtypes that are derived from authenticationEventListener.

Note

You can have a maximum of 250 event listeners.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ✅

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) EventListener.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application EventListener.ReadWrite.All Not available.

HTTP request

POST /identity/authenticationEventListeners

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the authenticationEventListener object.

You can specify the following properties when creating an authenticationEventListener. You must specify the @odata.type property to specify the type of authenticationEventListener to create; for example, @odata.type": "microsoft.graph.onTokenIssuanceStartListener".

Property Type Description
authenticationEventsFlowId String The identifier of the authentication events flow. Optional.
conditions authenticationConditions The conditions on which this authenticationEventListener should trigger. Optional.
handler onAttributeCollectionHandler The handler to invoke when conditions are met. Can be set for the onAttributeCollectionListener listener type.
handler onAttributeCollectionStartListener The handler to invoke when conditions are met. Can be set for the onAttributeCollectionStartListener listener type.
handler onAttributeCollectionSubmitListener The handler to invoke when conditions are met. Can be set for the onAttributeCollectionSubmitListener listener type.
handler onAuthenticationMethodLoadStartHandler The handler to invoke when conditions are met. Can be set for the onAuthenticationMethodLoadStartListener listener type.
handler onInteractiveAuthFlowStartHandler The handler to invoke when conditions are met. Can be set for the onInteractiveAuthFlowStartListener listener type.
handler onTokenIssuanceStartHandler The handler to invoke when conditions are met. Can be set for the onTokenIssuanceStartListener listener type.
handler onUserCreateStartHandler The handler to invoke when conditions are met. Can be set for the onUserCreateStartListener listener type.
priority Int32 The priority of this handler. Between 0 (lower priority) and 1000 (higher priority). Required.

Response

If successful, this method returns a 201 Created response code and an authenticationEventListener object in the response body. The @odata.type property specifies the type of the created object.

Examples

Example 1: Create an onTokenIssuanceStartListener object

Request

The following example shows a request.

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

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

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

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

Example 2: Create an onAttributeCollectionStartListener object

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/identity/authenticationEventListeners
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.onAttributeCollectionStartListener",
    "priority": 500,
    "conditions": {
        "applications": {
            "includeAllApplications": false,
            "includeApplications": [
                {
                    "appId": "a7eed01f-a333-4983-bc6b-d359ec9e5eef"
                }
            ]
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onAttributeCollectionStartCustomExtensionHandler",
        "customExtension": {
            "id": "2d9c3e8d-88a9-444e-8c4c-f0c6c4fe1c02"
        }
    }
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/authenticationEventListeners/$entity",
    "@odata.type": "#microsoft.graph.onAttributeCollectionStartListener",
    "id": "1b025b34-6547-4714-b948-43f79b70c429",
    "priority": 500,
    "authenticationEventsFlowId": null,
    "conditions": {
        "applications": {
            "includeAllApplications": false
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onAttributeCollectionStartCustomExtensionHandler",
        "configuration": null
    }
}

Example 3: Create an onAttributeCollectionSubmitListener object

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/identity/authenticationEventListeners
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.onAttributeCollectionSubmitListener",
    "priority": 500,
    "conditions": {
        "applications": {
            "includeAllApplications": false,
            "includeApplications": [
                {
                    "appId": "a7eed01f-a333-4983-bc6b-d359ec9e5eef"
                }
            ]
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onAttributeCollectionSubmitCustomExtensionHandler",
        "customExtension": {
            "id": "66867d1f-7824-4f38-aad1-75da1ad09ee2"
        }
    }
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/authenticationEventListeners/$entity",
    "@odata.type": "#microsoft.graph.onAttributeCollectionSubmitListener",
    "id": "2066575e-fc31-4ac7-b07c-81b85f074441",
    "priority": 500,
    "authenticationEventsFlowId": null,
    "conditions": {
        "applications": {
            "includeAllApplications": false
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onAttributeCollectionSubmitCustomExtensionHandler",
        "configuration": null
    }
}