リスト onSignUpStart リスナー

[アーティクル]
09/26/2021

名前空間: microsoft.graph

重要

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

onSignupStart イベントでサポートされている authenticationListener リソースのコレクションを取得します。 onSignUpStart イベントは invokeUserFlowListener 型をサポートします。

invokeUserFlowListenerが onSignUpStart イベントに割り当てられると、アプリケーションはユーザーフローに関連付けられるため、セルフサービスサインアッププロセスが有効になります。ユーザーフローを呼び出す認証イベントが作成されると、そのアプリケーションに移動するユーザーは、ゲストアカウントをプロビジョニングするサインアップフローを開始できます。

アクセス許可

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

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

HTTP 要求

GET /identity/events/onSignupStart

オプションのクエリパラメーター

このメソッドは $expand 、OData クエリパラメーターをサポートして、invokeUserFlowListener の詳細を展開します。例については、以下を参照してください。一般的な情報については、「OData クエリパラメーター」を参照してください。

要求ヘッダー

名前	説明
Authorization	ベアラー {トークン}。必須。

要求本文

このメソッドには、要求本文を指定しません。

応答

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

例

例 1: onSignUpStart イベントのリスト認証Listeners

要求

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

GET https://graph.microsoft.com/beta/identity/events/onSignupStart

応答

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

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/events/onSignUpStart",
  "value": [
    {
      "@odata.type": "#microsoft.graph.invokeUserFlowListener",
      "id": "2adb5c12-5c12-2adb-125c-db2a125cdb2a",
      "priority": 101,
      "sourceFilter": {
        "includeApplications": [
            "3dfff01b-0afb-4a07-967f-d1ccbd81102a"
        ]
      }
    },
    {
      "@odata.type": "#Microsoft.Graph.InvokeUserFlowListener",
      "id": "0a09997f-fa0c-4f3c-9d02-76762ac069c8",
      "priority": 100,
      "sourceFilter": {
          "includeApplications": [
              "b0e1638f-4c39-4cd1-82b3-91d1caef65f8"
        ]
      }
    }
  ]
}

例 2: onSignUpStart イベントの authenticationListeners で invokeUserFlowListeners を展開する

次の例では、onSignupStart イベントに対して定義されているリスナーを一覧表示し、各リスナーに対して、呼び出されるユーザーフローを展開します。

要求