Тип ресурса b2cIdentityUserFlow

Статья
03/26/2023

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

Важно!

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

Представляет пользовательский поток в клиенте Azure Active Directory B2C.

Чтобы помочь с настройкой наиболее распространенных задач идентификации для ваших приложений, Azure Active Directory B2C содержит заранее определенные настраиваемые политики, называемые пользовательскими потоками. Пользовательский поток позволяет вам определить, как пользователи взаимодействуют с вашим приложением, когда они выполняют такие задачи, как вход, регистрация, изменение профиля или сброс пароля. Вы можете создать множество пользовательских потоков различных типов в своем клиенте и использовать их в приложении по мере необходимости. С помощью пользовательских потоков вы можете управлять следующими возможностями:

Типы учетных записей, используемые для входа, например учетные записи социальных сетей, таких как Facebook, или локальные учетные записи
Атрибуты, собираемые у пользователей, такие как имя, почтовый индекс и размер обуви
Многофакторная проверка подлинности Azure
Настройка пользовательского интерфейса
Сведения, получаемые приложением в маркере

Методы

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

Свойства

Свойство	Тип	Описание
id	Строка	Имя пользовательского потока. Это обязательное значение, не изменяемое после создания. После создания перед именем будет добавлен префикс со значением `B2C_1_`.
userFlowType	userFlowType	Тип пользовательского потока. Поддерживаемые значения для userFlowType: `signUp`, `signIn`, `signUpOrSignIn`, `passwordReset`, `profileUpdate`, `resourceOwner`.
userFlowTypeVersion	Одинарное	Версия пользовательского потока.
isLanguageCustomizationEnabled	Логический	Свойство, определяющее, включена ли языковая настройка в пользовательском потоке B2C. Настройка языка по умолчанию не включена для пользовательского потока B2C.
defaultLanguageTag	Строка	Указывает b2cIdentityUserFlow как язык по умолчанию, который используется, если в запросе не указан тег `ui_locale`. Это поле соответствует спецификации RFC 5646.
apiConnectorConfiguration	userFlowApiConnectorConfiguration	Настройка для включения соединителя API с целью использования в составе пользовательского потока. Вы можете получить значение этого объекта только с помощью метода Получение userFlowApiConnectorConfiguration.

Отношения

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

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

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

{
    "id": "String (identifier)",
    "userFlowType": "String",
    "userFlowTypeVersion": "Single",
    "isLanguageCustomizationEnabled": "Boolean",
    "defaultLanguageTag": "String",
    "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"
    }
}