Поделиться через

Создание authenticationEventListener

  • Статья

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Создайте объект authenticationEventListener . Можно создать один из следующих подтипов, производных от authenticationEventListener.

Примечание.

Можно использовать не более 250 прослушивателей событий.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ✅

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) EventListener.ReadWrite.All Недоступно.
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение EventListener.ReadWrite.All Недоступно.

HTTP-запрос

POST /identity/authenticationEventListeners

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление объекта authenticationEventListener в формате JSON.

При создании authenticationEventListener можно указать следующие свойства. Необходимо указать свойство @odata.type , чтобы указать тип проверки подлинностиEventListener для создания; например, @odata.type": "microsoft.graph.onTokenIssuanceStartListener".

Свойство Тип Описание
authenticationEventsFlowId String Идентификатор потока событий проверки подлинности. Необязательный параметр.
conditions authenticationConditions Условия, при которых должна активироваться проверка подлинностиEventListener. Необязательный параметр.
handler onAttributeCollectionHandler Обработчик, вызываемый при выполнении условий. Можно задать для типа прослушивателя onAttributeCollectionListener .
handler onAttributeCollectionStartListener Обработчик, вызываемый при выполнении условий. Можно задать для типа прослушивателя onAttributeCollectionStartListener .
handler onAttributeCollectionSubmitListener Обработчик, вызываемый при выполнении условий. Можно задать для типа прослушивателя onAttributeCollectionSubmitListener .
handler onAuthenticationMethodLoadStartHandler Обработчик, вызываемый при выполнении условий. Можно задать для типа прослушивателя onAuthenticationMethodLoadStartListener .
handler onInteractiveAuthFlowStartHandler Обработчик, вызываемый при выполнении условий. Можно задать для типа прослушивателя onInteractiveAuthFlowStartListener .
handler onTokenIssuanceStartHandler Обработчик, вызываемый при выполнении условий. Можно задать для типа прослушивателя onTokenIssuanceStartListener .
handler onUserCreateStartHandler Обработчик, вызываемый при выполнении условий. Можно задать для типа прослушивателя onUserCreateStartListener .
priority Int32 Приоритет этого обработчика. От 0 (более низкий приоритет) до 1000 (более высокий приоритет). Обязательно.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 201 Created и объект authenticationEventListener в теле отклика. Свойство @odata.type указывает тип созданного объекта.

Примеры

Пример 1. Создание объекта onTokenIssuanceStartListener

Запрос

Ниже показан пример запроса.

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"
        }
    }
}

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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"
        }
    }
}

Пример 2. Создание объекта onAttributeCollectionStartListener

Запрос

Ниже показан пример запроса.

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"
        }
    }
}

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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
    }
}

Пример 3. Создание объекта onAttributeCollectionSubmitListener

Запрос

Ниже показан пример запроса.

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"
        }
    }
}

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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
    }
}