b2cIdentityUserFlow を作成する

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

新しい b2cIdentityUserFlow オブジェクトを 作成します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) IdentityUserFlow.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション IdentityUserFlow.ReadWrite.All 注意事項なし。

職場または学校アカウントは、少なくとも外部 ID ユーザー フロー管理者Microsoft Entraロールに属している必要があります。

HTTP 要求

POST /identity/b2cUserFlows

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、 b2cIdentityUserFlow の JSON 表現を指定します。

プロパティ 型 説明
id String 必須です。 ユーザー フローの名前。 要求中にプレフィックスが名前に B2C_1_ 追加されなかった場合、名前は作成後に先頭に付加されます。
userFlowType String 必須です。 作成するユーザー フローの種類。 userFlowType でサポートされる値は次のとおりです。
  • signUp
  • signIn
  • signUpOrSignIn
  • passwordReset
  • profileUpdate
  • resourceOwner
userFlowTypeVersion 浮動小数点数 必須です。 ユーザー フローのバージョン。
isLanguageCustomizationEnabled ブール値 省略可能。 Azure AD B2C ユーザー フロー内で言語のカスタマイズが有効かどうかを判断します。 Azure AD B2C ユーザー フローでは、言語のカスタマイズは既定では有効になっていません。
defaultLanguageTag String 省略可能。 要求でタグが指定されていない ui_locale 場合に使用される b2cIdentityUserFlow の既定の言語を指定します。 このフィールドは RFC5646 に準拠しています。
identityProviders identityProvider コレクション オプション。 ユーザー フローに含める ID プロバイダー。

応答

成功した場合、このメソッド 201 Created は応答コードと Uri を持つ Location ヘッダーを、この要求用に作成された 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: 既定値と ID プロバイダーを使用してユーザー フローを作成する

要求

要求の例を次に示します。

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": {}
}