OnSignUpStart-Listener auflisten

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Ruft die Sammlung der AuthentifizierungListener-Ressourcen ab, die vom onSignupStart-Ereignis unterstützt werden. Das onSignUpStart-Ereignis unterstützt den InvokeUserFlowListener-Typ.

Wenn ein invokeUserFlowListener einem onSignUpStart-Ereignis zugewiesen wird, wird eine Anwendung einem Benutzerablauf zugeordnet, sodass ein Self-Service-Registrierungsvorgang aktiviert wird. Nachdem das Authentifizierungsereignis zum Aufrufen eines Benutzerablaufs erstellt wurde, können Benutzer, die zu dieser Anwendung wechseln, einen Registrierungsfluss initiieren, der ein Gastkonto bereitstellt.

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Berechtigungstyp Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto) Policy.Read.All, Policy.ReadWrite.ApplicationConfiguration
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt
Application Policy.Read.All, Policy.ReadWrite.ApplicationConfiguration

HTTP-Anforderung

GET /identity/events/onSignupStart

Optionale Abfrageparameter

Diese Methode unterstützt den $expand OData-Abfrageparameter, um die Details eines invokeUserFlowListener zu erweitern. Ein Beispiel finden Sie unten. Allgemeine Informationen finden Sie unter OData-Abfrageparameter.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich.

Anforderungstext

Geben Sie für diese Methode keinen Anforderungstext an.

Antwort

Bei erfolgreicher Ausführung gibt die Methode den 200 OK Antwortcode und eine Sammlung von authenticationListener-Objekten im Antworttext zurück.

Beispiele

Beispiel 1: Auflisten von Authentifizierungslisten für das onSignUpStart-Ereignis

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

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

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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"
        ]
      }
    }
  ]
}

Beispiel 2: Erweitern von invokeUserFlowListeners in authenticationListeners für das onSignUpStart-Ereignis

Im folgenden Beispiel werden die Listener aufgelistet, die für das onSignupStart-Ereignis definiert sind, und für jeden Listener wird der aufgerufene Benutzerablauf erweitert.

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

GET https://graph.microsoft.com/beta/identity/events/onSignupStart?$expand=microsoft.graph.invokeUserFlowListener/userFlow

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

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