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

Обновление authenticationEventsFlow

  • Статья

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

Обновите свойства объекта authenticationEventsFlow по идентификатору. Необходимо указать свойство @odata.type и значение типа объекта authenticationEventsFlow для обновления. Поддерживаются следующие производные подтипы:

Этот 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 Условия, представляющие контекст запроса проверки подлинности, который используется для решения о том, вызывается ли политика событий.
onInteractiveAuthFlowStart onInteractiveAuthFlowStartHandler Конфигурация того, что вызывается для события onInteractiveAuthFlowStart.
onAuthenticationMethodLoadStart onAuthenticationMethodLoadStartHandler Конфигурация для вызова события onAuthenticationMethodLoadStart. Должен быть связан хотя бы один поставщик удостоверений.
onAttributeCollection onAttributeCollectionHandler Конфигурация для вызова события onAttributeCollection.

  • Это свойство можно обновить только в том случае, если оно было настроено во время создания потока пользователя. Если это не так, сначала вызовите добавление атрибутов в API потока пользователя .
  • Невозможно добавить или удалить атрибуты, обновиввходные данные и объекты атрибутовattributeCollectionPage>>. Вместо этого используйте api Add attribute to user flow (Добавить атрибут в поток пользователя ) или Remove attribute from user flow (Удалить атрибут из потока пользователя ), чтобы обновить оба объекта.
  • Чтобы обновить коллекциювходных данныхпредставлений>attributeCollectionPage>, необходимо включить в коллекцию все объекты, а не только измененные объекты.
  • Порядок объектов в коллекциивходных данныхattributeCollectionPage>> соответствует порядку, в котором атрибуты отображаются в пользовательском интерфейсе регистрации приложения.
    		•
    onUserCreateStart onUserCreateStartHandler Конфигурация для вызова события onUserCreateStart.

    Отклик

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

    Примеры

    Пример 1. Обновление отображаемого имени потока пользователя для самостоятельной регистрации внешних удостоверений

    Запрос

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

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

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

    Отклик

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

    HTTP/1.1 204 No Content

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

    Следующий запрос обновляет конфигурацию некоторых атрибутов. Все атрибуты помечаются как обязательные; атрибут электронной почты помечается как скрытый; Тип ввода настраиваемого атрибута также обновляется до переключателя с двумя параметрами.

    Запрос

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

{
    "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
    "onAttributeCollection": {
        "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",
        "attributeCollectionPage": {
            "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": true,
                            "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": true,
                            "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
                            "options": []
                        },
                        {
                            "attribute": "extension_331d514c0c18477583ea7dd5a79feda2_RockorCountry",
                            "label": "Rock music or Country",
                            "inputType": "radioSingleSelect",
                            "defaultValue": null,
                            "hidden": false,
                            "editable": true,
                            "writeToDirectory": true,
                            "required": true,
                            "validationRegEx": "^.*",
                            "options": [
                                {
                                    "label": "Rock music",
                                    "value": "Rock"
                                },
                                {
                                    "label": "Country music",
                                    "value": "Country"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

    Отклик

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

    HTTP/1.1 204 No Content