Обновление authenticationEventsFlow

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

Важно!

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

Обновление свойств объекта authenticationEventsFlow . Поддерживается только тип объекта externalUsersSelfServiceSignupEventsFlow .

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

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

Разрешения

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

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

Для делегированных сценариев администратору требуется по крайней мере роль администратора потока пользователей с внешним идентификаторомMicrosoft Entra.

HTTP-запрос

PATCH /identity/authenticationEventsFlows/{authenticationEventsFlow-id}

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

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

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

Укажите в тексте запроса только значения обновляемых свойств. Существующие свойства, которые не включены в текст запроса, сохраняют свои предыдущие значения или пересчитываются на основе изменений других значений свойств.

В следующей таблице указаны свойства, которые можно обновить.

Необходимо включить свойство @odata.type со значением определенного типа потока пользователя в тексте. Например, "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow".

Свойство Тип Описание
id String Уникальный идентификатор сущности. Только для чтения.
displayName String Отображаемое имя политики событий.
description String Описание политики событий.
conditions authenticationConditions Условия, представляющие контекст запроса проверки подлинности, который используется для решения о том, вызывается ли политика событий.
priority Int32 Приоритет, используемый для каждого отдельного события политики событий. Если несколько конкурирующих прослушивателей для события имеют одинаковый приоритет, выбирается один из них, а ошибка регистрируется автоматически.
onInteractiveAuthFlowStart onInteractiveAuthFlowStartHandler Конфигурация того, что вызывается для события onInteractiveAuthFlowStart.
onAuthenticationMethodLoadStart onAuthenticationMethodLoadStartHandler Конфигурация для вызова события onAuthenticationMethodLoadStart. Должен быть связан хотя бы один поставщик удостоверений.
onAttributeCollection onAttributeCollectionHandler Конфигурация для вызова события onAttributeCollection.
onUserCreateStart onUserCreateStartHandler Конфигурация для вызова события onUserCreateStart.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 204 No Content. В случае неудачи 4xx возвращается ошибка с определенными сведениями.

Примеры

Пример 1. Обновление отображаемого имени и приоритета authenticationEventsFlow

Запрос

В следующем примере показан запрос, который обновляет отображаемое имя определенного потока пользователя внешних удостоверений (тип события проверки подлинности), а также приоритет для всех прослушивателей, связанных с политикой.

PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
  "displayName": "New user flow description",
  "priority": 200
}

Отклик

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

HTTP/1.1 204 No Content

Пример 2. Обновление события onAttributeCollection пользовательского потока самостоятельной регистрации

Добавьте город (встроенный атрибут) в качестве атрибута, который будет собираться на этапе сбора атрибутов в пользовательском потоке самостоятельной регистрации. Необходимо указать в объекте inputs все атрибуты, которые нужно сохранить, в противном случае они будут удалены из потока пользователя.

Запрос

PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
    "onAttributeCollection": {
        "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",
        "attributeCollectionPage": {
            "customStringsFileId": null,
            "views": [
                {
                    "title": null,
                    "description": null,
                    "inputs": [
                        {
                            "attribute": "email",
                            "label": "Email Address",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": true,
                            "editable": false,
                            "writeToDirectory": true,
                            "required": true,
                            "validationRegEx": "^[a-zA-Z0-9.!#$%&’'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$",
                            "options": []
                        },
                        {
                            "attribute": "displayName",
                            "label": "Display Name",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": false,
                            "editable": true,
                            "writeToDirectory": true,
                            "required": false,
                            "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
                            "options": []
                        },
                        {
                            "attribute": "city",
                            "label": "City",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": false,
                            "editable": true,
                            "writeToDirectory": true,
                            "required": false,
                            "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
                            "options": []
                        },
                        {
                            "attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",
                            "label": "Favorite color",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": false,
                            "editable": true,
                            "writeToDirectory": true,
                            "required": false,
                            "validationRegEx": "^.*",
                            "options": []
                        }
                    ]
                }
            ]
        }
    }
}

Отклик

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

HTTP/1.1 204 No Content

Пример 3. Удаление атрибута, собранного во время потока пользователя самостоятельной регистрации

Удалите город в качестве атрибута, который будет собираться на этапе сбора атрибутов в потоке пользователя самостоятельной регистрации. При исключении атрибута city из текста запроса атрибут удаляется из потока пользователя.

Запрос

PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
    "onAttributeCollection": {
        "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",
        "attributeCollectionPage": {
            "customStringsFileId": null,
            "views": [
                {
                    "title": null,
                    "description": null,
                    "inputs": [
                        {
                            "attribute": "email",
                            "label": "Email Address",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": true,
                            "editable": false,
                            "writeToDirectory": true,
                            "required": true,
                            "validationRegEx": "^[a-zA-Z0-9.!#$%&’'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$",
                            "options": []
                        },
                        {
                            "attribute": "displayName",
                            "label": "Display Name",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": false,
                            "editable": true,
                            "writeToDirectory": true,
                            "required": false,
                            "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
                            "options": []
                        },
                        {
                            "attribute": "extension_6ea3bc85aec24b1c92ff4a117afb6621_Favoritecolor",
                            "label": "Favorite color",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": false,
                            "editable": true,
                            "writeToDirectory": true,
                            "required": false,
                            "validationRegEx": "^.*",
                            "options": []
                        }
                    ]
                }
            ]
        }
    }
}

Отклик

Ниже приводится пример отклика.

HTTP/1.1 204 No Content