Тип ресурса b2xIdentityUserFlow

  • Статья

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

Важно!

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

Представляет поток пользователя самостоятельной регистрации в клиенте Microsoft Entra.

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

Методы

Метод Возвращаемый тип Описание
Перечисление пользовательских потоков Коллекция b2xIdentityUserFlow Извлечение всех пользовательских потоков B2X.
Получение пользовательского потока b2xIdentityUserFlow Извлечение свойств пользовательского потока B2X.
Создание пользовательского потока b2xIdentityUserFlow Создание пользовательского потока B2X.
Удаление пользовательского потока Нет Удаление пользовательского потока B2X.
Перечисление поставщиков удостоверений Коллекция объектов identityProvider Получение всех поставщиков удостоверений в пользовательском потоке B2X.
Добавление поставщика удостоверений Нет Добавление поставщика удостоверений в пользовательский поток B2X.
Удаление поставщика удостоверений Нет Удаление поставщика удостоверений из пользовательского потока B2X.
Перечисление поставщиков удостоверений (не рекомендуется) Коллекция объектов identityProvider Получение всех поставщиков удостоверений в пользовательском потоке B2X.
Добавление поставщика удостоверений (не рекомендуется) Нет Добавление поставщика удостоверений в пользовательский поток B2X.
Удаление поставщика удостоверений (не рекомендуется) Нет Удаление поставщика удостоверений из пользовательского потока B2X.
Назначения атрибутов пользователя в списке Коллекция identityUserFlowAttributeAssignment Извлечение всех назначений атрибутов пользователя в потоке пользователей B2X.
Создание назначения атрибута пользователя identityUserFlowAttributeAssignment Создание назначения атрибута пользователя в потоке пользователей B2X.
Перечисление языков Коллекция userFlowLanguageConfiguration Получение всех языков в пользовательском потоке B2X.
Получение конфигурации соединителей API для пользовательского потока userFlowApiConnectorConfiguration Получение конфигурации для соединителей API, применяемых в пользовательском потоке. Параметр запроса $expand не поддерживается для этого метода.
Настройка соединителя API в пользовательском потоке Нет Настройка соединителя API для определенных шагов в пользовательском потоке путем обновления свойства apiConnectorConfiguration.

Свойства

Свойство Тип Описание
id Строка Имя пользовательского потока. Это обязательное значение, не изменяемое после создания. После создания перед именем будет добавлен префикс со значением B2X_1_.
userFlowType userFlowType Тип пользовательского потока. Для потоков пользователей самостоятельной регистрации значение может быть signUpOrSignIn только и не может быть изменено после создания.
userFlowTypeVersion Одинарное Версия пользовательского потока. Для пользовательских потоков самостоятельной регистрации всегда применяется версия 1.
apiConnectorConfiguration userFlowApiConnectorConfiguration Настройка для включения соединителя API с целью использования в составе пользовательского потока самостоятельной регистрации. Вы можете получить значение этого объекта только с помощью метода Получение userFlowApiConnectorConfiguration.

Отношения

Связь Тип Описание
userflowIdentityProviders Коллекция identityProviderBase Поставщики удостоверений, включенные в пользовательский поток.
identityProviders (не рекомендуется) Коллекция объектов identityProvider Поставщики удостоверений, включенные в пользовательский поток.
userAttributeAssignments Коллекция identityUserFlowAttributeAssignment Назначения атрибутов пользователя, включенные в поток пользователей.
languages Коллекция userFlowLanguageConfiguration Языки, поддерживаемые при настройке в пользовательском потоке. Настройка языка включена по умолчанию в пользовательском потоке самостоятельной регистрации. Вы не можете создавать пользовательские языки в потоках пользователей самостоятельной регистрации.

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

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

{
    "id": "String (identifier)",
    "userFlowType": "String",
    "userFlowTypeVersion": "Single",
    "userflowIdentityProviders": [{"@odata.type": "microsoft.graph.identityProviderBase"}],
    "identityProviders": [{"@odata.type": "microsoft.graph.identityProvider"}],
    "userAttributeAssignments": [{"@odate.type": "microsoft.graph.identityUserFlowAttributeAssignment"}],
    "languages": [{"@odata.type": "microsoft.graph.userFlowLanguageConfiguration"}],
    "apiConnectorConfiguration": {
      "@odata.type": "microsoft.graph.userFlowApiConnectorConfiguration"
    }
}