Создание b2xIdentityUserFlow

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

Создайте объект b2xIdentityUserFlow .

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

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

Разрешения

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

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

Рабочая или учебная учетная запись должна принадлежать по крайней мере к роли администратора потока пользователей внешнего идентификатораMicrosoft Entra.

HTTP-запрос

POST /identity/b2xUserFlows

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

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

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

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

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

Отклик

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

Примеры

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

Запрос

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

POST https://graph.microsoft.com/v1.0/identity/b2xUserFlows
Content-type: application/json

{
    "id": "Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}

Отклик

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

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

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_Partner
Content-type: application/json

{
    "id": "B2X_1_Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}

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

Запрос

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

POST https://graph.microsoft.com/v1.0/identity/b2xUserFlows
Content-type: application/json

{
    "id": "Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "identityProviders": [
        {
            "id": "Facebook-OAuth",
            "type": "Facebook",
            "name": "Facebook"
        }
    ]
}

Отклик

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

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

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_Partner
Content-type: application/json

{
    "id": "B2X_1_Partner",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1
}

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

Запрос

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

POST https://graph.microsoft.com/v1.0/identity/b2xUserFlows
Content-type: application/json

{
    "id": "UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration":{
        "postFederationSignup":{
            "@odata.id": "https://graph.microsoft.com/v1/identity/apiConnectors/{id}"
        },
        "postAttributeCollection":{
            "@odata.id": "https://graph.microsoft.com/v1/identity/apiConnectors/{id}"
        }
    }
}

Отклик

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

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

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

HTTP/1.1 201 Created
Location: https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_Partner
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/b2xUserFlows/$entity",
    "id": "B2X_1_UserFlowWithAPIConnector",
    "userFlowType": "signUpOrSignIn",
    "userFlowTypeVersion": 1,
    "apiConnectorConfiguration": {}
}