Тип ресурса externalUsersSelfServiceSignUpEventsFlow

Статья
08/07/2024

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

Важно!

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

Представляет поток пользователей самообслуживания для внешних удостоверений в microsoft Entra External ID для сотрудников или внешних клиентов. Поток пользователя реализуется как политика нескольких событий, выполняющая определенные события в определенных точках взаимодействия с пользователем.

Наследует от authenticationEventsFlow.

Методы

Нет.

Список операций API для управления этим типом ресурсов см. в разделе Тип ресурса authenticationEventsFlow.

Свойства

Свойство	Тип	Описание
id	String	Уникальный идентификатор сущности. Только для чтения. Наследуется от сущности.
displayName	String	Обязательный. Отображаемое имя политики событий. Имя должно быть уникальным. Наследуется от authenticationEventsFlow.
description	String	Необязательный параметр. Описание политики событий. Наследуется от authenticationEventsFlow.
conditions	authenticationConditions	Необязательный параметр. Условия, представляющие контекст запроса проверки подлинности, который используется для определения того, вызывается ли политика событий. Наследуется от authenticationEventsFlow.
priority	Int32	Необязательный параметр. Приоритет, используемый для каждого отдельного события политики событий. Если несколько конкурирующих прослушивателей для события имеют одинаковый приоритет, выбирается один из них, а ошибка регистрируется автоматически. Значение по умолчанию — 500. Наследуется от authenticationEventsFlow.
onInteractiveAuthFlowStart	onInteractiveAuthFlowStartHandler	Обязательно. Конфигурация того, что следует вызывать, когда поток проверки подлинности готов к инициации.
onAttributeCollection	onAttributeCollectionHandler	Конфигурация того, что следует вызывать, когда атрибуты готовы к сбору от пользователя.
onAttributeCollectionStart	onAttributeCollectionStartHandler	Конфигурация того, что следует вызывать при запуске сбора атрибутов.
onAttributeCollectionSubmit	onAttributeCollectionSubmitHandler	Конфигурация того, что следует вызывать при отправке атрибутов в конце коллекции атрибутов.
onAuthenticationMethodLoadStart	onAuthenticationMethodLoadStartHandler	Обязательно. Конфигурация того, что следует вызывать, когда методы проверки подлинности готовы к представлению пользователю. Должен быть связан хотя бы один поставщик удостоверений. Поддерживает `$filter` (`eq`). Сведения о синтаксисе см. в разделе Поддержка фильтрации по потокам пользователей .
onUserCreateStart	onUserCreateStartHandler	Конфигурация того, что вызывается во время создания пользователя.

Поддержка фильтрации по потокам пользователей

Фильтр по identityProviders: ?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/any(idp:idp/id eq '{identityProvider-id}')
Фильтрация по атрибутам: ?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/any(attribute:attribute/id eq '{attribute-ID}')
Фильтр по связанным приложениям: ?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/any(appId:appId/appId eq '{appId}')

Связи

Отсутствуют.

Представление JSON

В следующем представлении JSON показан тип ресурса.

{
  "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "conditions": {
    "@odata.type": "microsoft.graph.authenticationConditions"
  },
  "priority": "Integer",
  "onInteractiveAuthFlowStart": {
    "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartHandler"
  },
  "onAuthenticationMethodLoadStart": {
    "@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartHandler"
  },
  "onAttributeCollection": {
    "@odata.type": "microsoft.graph.onAttributeCollectionHandler"
  },
  "onAttributeCollectionStart": {
    "@odata.type": "microsoft.graph.onAttributeCollectionStartHandler"
  },
  "onAttributeCollectionSubmit": {
    "@odata.type": "microsoft.graph.onAttributeCollectionSubmitHandler"
  },
  "onUserCreateStart": {
    "@odata.type": "microsoft.graph.onUserCreateStartHandler"
  }
}

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