次の方法で共有

authenticationEventsFlow を更新する

  • [アーティクル]

名前空間: microsoft.graph

重要

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

authenticationEventsFlow オブジェクトのプロパティを ID で更新します。 更新するには、@odata.type プロパティと authenticationEventsFlow オブジェクトの種類の値を指定する必要があります。 次の派生サブタイプがサポートされています。

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

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

アクセス許可

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

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

重要

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

HTTP 要求

PATCH /identity/authenticationEventsFlows/{authenticationEventsFlow-id}

要求ヘッダー

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

要求本文

要求本文で、更新するプロパティの値 のみを 指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

@odata.type プロパティは、本文に特定のユーザー フローの種類の値を含める必要があります。 たとえば、「 "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow" 」のように入力します。

プロパティ 型 説明
id String エンティティの一意識別子。 読み取り専用です。
displayName String イベント ポリシーの表示名。
説明 String イベント ポリシーの説明。
conditions authenticationConditions イベント ポリシーが呼び出されるかどうかを判断するために使用される認証要求のコンテキストを表す条件。
priority Int32 イベント ポリシーの個々のイベントに使用する優先順位。 1 つのイベントに対して競合する複数のリスナーが同じ優先順位を持つ場合は、1 つが選択され、エラーがサイレント ログに記録されます。
onInteractiveAuthFlowStart onInteractiveAuthFlowStartHandler onInteractiveAuthFlowStart イベントに対して呼び出す内容の構成。
onAuthenticationMethodLoadStart onAuthenticationMethodLoadStartHandler onAuthenticationMethodLoadStart イベントに対して呼び出す内容の構成。 少なくとも 1 つの ID プロバイダーがリンクされている必要があります。
onAttributeCollection onAttributeCollectionHandler onAttributeCollection イベントに対して呼び出す内容の構成。

  • このプロパティは、ユーザー フローの作成時に構成されている場合にのみ更新できます。 そうでなかった場合は、まず ユーザー フロー API に属性を追加するを 呼び出します。
  • attributeCollectionPage>views>inputs および attributes オブジェクトを更新して属性を追加または削除することはできません。 両方のオブジェクトを更新するには、代わりに [ ユーザー フローに属性を追加する] または [ ユーザー フロー API から属性を削除 する] を使用します。
  • attributeCollectionPage>views>inputs コレクションを更新するには、変更されたオブジェクトだけでなく、コレクション内のすべてのオブジェクトを含める必要があります。
  • attributeCollectionPage>views>inputs コレクション内のオブジェクトの順序は、アプリのサインアップ UI に属性が表示される順序に対応します。
    		•
    onUserCreateStart onUserCreateStartHandler onUserCreateStart イベントに対して呼び出す内容の構成。

    応答

    成功した場合、このメソッドは 204 No Content 応答コードを返します。 失敗した場合は、特定の詳細を含む 4xx エラーが返されます。

    例

    例 1: authenticationEventsFlow の表示名と優先順位を更新する

    要求

    次の例は、特定の外部 ID ユーザー フローの表示名と、ポリシーに関連付けられているすべてのリスナーの優先順位を更新する要求を示しています。

    PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
  "displayName": "New user flow description",
  "priority": 200
}

    応答

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

    HTTP/1.1 204 No Content

    例 2: セルフサービス サインアップ ユーザー フローのページ レイアウトを更新する

    次の要求は、一部の属性の構成を更新します。 すべての属性は必須としてマークされます。電子メール属性は非表示としてマークされます。カスタム属性の入力の種類も、2 つのオプションを持つラジオ ボタンに更新されます。

    要求

    PATCH https://graph.microsoft.com/beta/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
    "onAttributeCollection": {
        "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",
        "attributeCollectionPage": {
            "customStringsFileId": null,
            "views": [
                {
                    "title": null,
                    "description": null,
                    "inputs": [
                        {
                            "attribute": "email",
                            "label": "Email Address",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": true,
                            "editable": false,
                            "writeToDirectory": true,
                            "required": true,
                            "validationRegEx": "^[a-zA-Z0-9.!#$%&’'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:.[a-zA-Z0-9-]+)*$",
                            "options": []
                        },
                        {
                            "attribute": "displayName",
                            "label": "Display Name",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": false,
                            "editable": true,
                            "writeToDirectory": true,
                            "required": true,
                            "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
                            "options": []
                        },
                        {
                            "attribute": "city",
                            "label": "City",
                            "inputType": "text",
                            "defaultValue": null,
                            "hidden": false,
                            "editable": true,
                            "writeToDirectory": true,
                            "required": true,
                            "validationRegEx": "^[a-zA-Z_][0-9a-zA-Z_ ]*[0-9a-zA-Z_]+$",
                            "options": []
                        },
                        {
                            "attribute": "extension_331d514c0c18477583ea7dd5a79feda2_RockorCountry",
                            "label": "Rock music or Country",
                            "inputType": "radioSingleSelect",
                            "defaultValue": null,
                            "hidden": false,
                            "editable": true,
                            "writeToDirectory": true,
                            "required": true,
                            "validationRegEx": "^.*",
                            "options": [
                                {
                                    "label": "Rock music",
                                    "value": "Rock"
                                },
                                {
                                    "label": "Country music",
                                    "value": "Country"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

    応答

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

    HTTP/1.1 204 No Content