認証の作成Listener

名前空間: microsoft.graph

重要

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

onSignUpStart イベントの新しい authenticationListener オブジェクトを作成します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Policy.ReadWrite.ApplicationConfiguration
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	Policy.ReadWrite.ApplicationConfiguration

HTTP 要求

POST /identity/events/onSignupStart

要求ヘッダー

名前	説明
Authorization	ベアラー {トークン}。必須。
Content-Type	application/json. Required.

要求本文

要求本文で 、authenticationListener オブジェクトの JSON 表記を指定します。

次の表に 、invokeUserFlowListener authenticationListener を作成するときに必要なプロパティを示します。

プロパティ	型	説明
priority	Int32	リスナーの優先度。 イベントに複数のリスナーがある場合の評価の順序を決定します。 優先度は低から高に評価されます。
sourceFilter	authenticationSourceFilter	リスナーが評価されるかどうかを判断するために使用される認証のソースに基づいてフィルター処理します。 これは現在、ユーザーが認証するアプリケーションに基づく評価に制限されています。
userFlow	b2xIdentityUserFlow	このアクションの評価時に呼び出される b2xIdentityUserFlow オブジェクト。

応答

成功した場合、このメソッドは応答コードと、応答本文の 201 Created authenticationListener オブジェクトを返します。

例

要求

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

POST https://graph.microsoft.com/beta/identity/events/onSignupStart
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.invokeUserFlowListener",
    "priority": 101,
    "sourceFilter": {
        "includeApplications": [
            "1fc41a76-3050-4529-8095-9af8897cf63d"
        ]
    },
    "userFlow": {
        "id": "B2X_1_Partner"
    }
}

応答

応答の例を次に示します。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/events/onSignupStart/Microsoft.Graph.InvokeUserFlowListener/$entity",
    "@odata.type": "#microsoft.graph.invokeUserFlowListener",
    "id": "2be3336b-e3b4-44f3-9128-b6fd9ad39bb8",
    "priority": 101,
    "sourceFilter": {
        "includeApplications": [
            "1fc41a76-3050-4529-8095-9af8897cf63d"
        ]
    }
}