userFlowApiConnectorConfiguration を構成する

  • [アーティクル]

名前空間: microsoft.graph

重要

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

b2cIdentityUserFlow の apiConnectorConfiguration プロパティを更新して、ユーザー フローで API コネクタを有効または無効にします。 apiConnectorConfiguration の各関係は、API コネクタを呼び出すように構成できるユーザー フロー内の特定の手順に対応します。 ユーザー フロー内の特定のステップに対して一度に API コネクタを構成します。

アクセス許可

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

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

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされている Microsoft Entra ロール またはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。 外部 ID ユーザー フロー管理者 は、この操作でサポートされる最小限の特権ロールです。

HTTP 要求

PUT /identity/b2cUserFlows/{b2cUserFlowId}/apiConnectorConfiguration/{step}/$ref

要求ヘッダー

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

要求本文

要求本文で、特定の手順を使用する identityApiConnector のidの JSON 表現を指定します。 API コネクタを無効にするには、値を {}できます。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。

例

例 1: サインアップ時に IdP フェデレーション後の API コネクタを有効にする

要求

次の例は要求を示しています。

PUT https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_testuserflow/apiConnectorConfiguration/postFederationSignup/$ref
Content-Type: application/json

{
    "@odata.id": "https://graph.microsoft.com/beta/identity/apiConnectors/{id}"   
}

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content

例 2: サインアップ時に Post Attribute Collection の API コネクタを有効にする

要求

次の例は要求を示しています。

PUT https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_testuserflow/apiConnectorConfiguration/postAttributeCollection/$ref
Content-Type: application/json

{
    "@odata.id": "https://graph.microsoft.com/beta/identity/apiConnectors/{id}"   
}

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content

例 3: サインアップ時に Post Attribute Collection の API コネクタを無効にする

要求

次の例は要求を示しています。

PUT https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_testuserflow/apiConnectorConfiguration/postAttributeCollection/$ref
Content-Type: application/json

{ }

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content