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


Создание b2cIdentityUserFlow

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

Важно!

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

Создайте новый объект b2cIdentityUserFlow .

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

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

Разрешения

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

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

Важно!

В делегированных сценариях с рабочими или учебными учетными записями вошедшему пользователю должна быть назначена поддерживаемая роль Microsoft Entra или настраиваемая роль с разрешением поддерживаемой роли. Внешняя идентификация администратор потока пользователей — это наименее привилегированная роль, поддерживаемая для этой операции.

HTTP-запрос

POST /identity/b2cUserFlows

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

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

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

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

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

Отклик

В случае успешного выполнения этот метод возвращает код отклика 201 Created и заголовок Location с универсальным кодом ресурса (URI) для объекта b2cIdentityUserFlow , созданного для этого запроса, с B2C_1_ префиксом, добавленным в имя. В случае неудачи 4xx возвращается ошибка с определенными сведениями.

Примеры

Пример 1. Создание потока пользователя со значениями по умолчанию

Запрос

Ниже приведен пример запроса.

POST https://graph.microsoft.com/beta/identity/b2cUserFlows
Content-type: application/json

{
    "id": "Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3
}

Отклик

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

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/beta/identity/b2cUserFlows('B2C_1_Customer')
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2cUserFlows/$entity",
    "id": "B2C_1_Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3,
    "isLanguageCustomizationEnabled": false,
    "defaultLanguageTag": "en",
    "authenticationMethods": "emailWithPassword",
    "tokenClaimsConfiguration": {
        "isIssuerEntityUserFlow": false
    },
    "apiConnectorConfiguration": {}
}

Пример 2. Создание потока пользователя со значениями по умолчанию и поставщиком удостоверений

Запрос

Ниже приведен пример запроса.

POST https://graph.microsoft.com/beta/identity/b2cUserFlows
Location: https://graph.microsoft.com/beta/identity/b2cUserFlows('B2C_1_Customer')
Content-type: application/json

{
    "id": "Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3,
    "identityProviders": [
        {
            "id": "Facebook-OAuth"
        }
    ]
}

Отклик

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

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2cUserFlows/$entity",
    "id": "B2C_1_Customer",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 3,
    "isLanguageCustomizationEnabled": false,
    "defaultLanguageTag": "en",
    "authenticationMethods": "0",
    "tokenClaimsConfiguration": {
        "isIssuerEntityUserFlow": false
    },
    "apiConnectorConfiguration": {}
}

Пример 3. Создание потока пользователя со значениями по умолчанию и конфигурацией для соединителей API

Запрос

Ниже приведен пример запроса.

POST https://graph.microsoft.com/beta/identity/b2cUserFlows
Content-type: application/json

{
    "id": "UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration":{
        "postFederationSignup":{
            "@odata.id": "{apiConnectorId}"
        },
        "postAttributeCollection":{
            "@odata.id": "{apiConnectorId}"
        }
    }
}

Отклик

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

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

Заметка: Свойство apiConnectorConfiguration всегда возвращает значение "{}". Чтобы просмотреть полное значение со свойствами навигации, используйте этот API.

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_Partner
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2cUserFlows/$entity",
    "id": "B2C_1_UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration": {}
}