Erstellen von authenticationEventListener

Namespace: microsoft.graph

Erstellen Sie ein neues authenticationEventListener-Objekt . Sie können einen der folgenden Untertypen erstellen, die von authenticationEventListener abgeleitet sind.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) EventListener.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application EventListener.ReadWrite.All Nicht verfügbar.

Wichtig

Für den delegierten Zugriff über Geschäfts-, Schul- oder Unikonten muss dem Administrator eine unterstützte Microsoft Entra Rolle oder eine benutzerdefinierte Rolle zugewiesen werden, die die für diesen Vorgang erforderlichen Berechtigungen gewährt. Dieser Vorgang unterstützt die folgenden integrierten Rollen, die nur die geringsten Berechtigungen bereitstellen:

  • Authentifizierungserweiterungsadministrator
  • Anwendungsadministrator

HTTP-Anforderung

POST /identity/authenticationEventListeners

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des authenticationEventListener-Objekts an.

Sie können die folgenden Eigenschaften angeben, wenn Sie einen authenticationEventListener erstellen. Sie müssen die @odata.type-Eigenschaft angeben, um den Typ von authenticationEventListener anzugeben, der erstellt werden soll. Beispiel: @odata.type": "microsoft.graph.onTokenIssuanceStartListener".

Eigenschaft Typ Beschreibung
Bedingungen authenticationConditions Die Bedingungen, unter denen dieser authenticationEventListener ausgelöst werden soll. Optional.
displayName Zeichenfolge Der Anzeigename der Authentifizierungsereignislistenerrichtlinie. Optional.
handler onTokenIssuanceStartHandler oder onFraudProtectionLoadStartHandler Der Handler, der aufgerufen werden soll, wenn Bedingungen erfüllt sind. Legen Sie für onTokenIssuanceStartListener auf onTokenIssuanceStartHandler fest. Legen Sie für onFraudProtectionLoadStartListener auf onFraudProtectionLoadStartHandler fest.
handler onPasswordSubmitHandler Der Handler, der aufgerufen werden soll, wenn Bedingungen erfüllt sind. Kann für den listener-Typ onPasswordSubmitListener festgelegt werden.

Antwort

Bei erfolgreicher Ausführung gibt die Methode den 201 Created Antwortcode und ein authenticationEventListener-Objekt im Antworttext zurück. Die @odata.type-Eigenschaft gibt den Typ des erstellten Objekts an.

Beispiele

Beispiel 1: Erstellen von authenticationEventListener

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json
Content-length: 312

{
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",
    "conditions": {
        "applications": {
            "includeApplications": [
                {
                    "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4"
                }
            ]
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler",
        "customExtension": {
            "id": "6fc5012e-7665-43d6-9708-4370863f4e6e"
        }
    }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",
    "id": "990d94e5-cc8f-4c4b-97b4-27e2678aac28",
    "conditions": {
        "applications": {
            "includeApplications": [
                {
                    "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4"
                }
            ]
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler",
        "customExtension": {
            "id": "6fc5012e-7665-43d6-9708-4370863f4e6e"
        }
    }
}

Beispiel 2: Aktivieren des Betrugsschutzes während der Registrierung mit Arkose Labs

Anforderung

Das folgende Beispiel zeigt eine Anforderung, die Betrugsschutz während der Registrierung mithilfe von Arkose Labs ermöglicht.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json

{   
  "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartListener", 
  "conditions": { 
    "applications": { 
      "includeApplications": [ 
        { 
          "appId": "0001111-aaaa-2222-bbbb-3333cccc4444" 
        } 
      ] 
    } 
  }, 
  "handler": { 
    "@odata.type": 
"#microsoft.graph.onFraudProtectionLoadStartExternalUsersAuthHandler", 
    "signUp": { 
      "@odata.type": "#microsoft.graph.fraudProtectionProviderConfiguration", 
      "fraudProtectionProvider": { 
        "@odata.type": "#microsoft.graph.arkoseFraudProtectionProvider", 
        "id": "6fedd01b-0afb-4a07-967f-d1ccbd81102b" 
      } 
    } 
  } 
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
  "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartListener",
  "id": "49eb23d9-998b-47df-a462-aa12a20ae5fb",
  "conditions": {
    "applications": {
      "includeApplications": [
        {
          "appId": "0001111-aaaa-2222-bbbb-3333cccc4444"
        }
      ]
    }
  },
  "handler": {
    "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartExternalUsersAuthHandler",
    "signUp": {
      "fraudProtectionProvider": {
        "@odata.type": "#microsoft.graph.arkoseFraudProtectionProvider",
        "id": "fabe5100-cc02-46c1-bd0e-ce885fe367fd"
      }
    }
  }
}

Beispiel 3: Aktivieren des Betrugsschutzes während der Registrierung mit HUMAN Security

Anforderung

Das folgende Beispiel zeigt eine Anforderung, die Betrugsschutz während der Registrierung mithilfe von HUMAN Security ermöglicht.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json

{   
  "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartListener", 
  "conditions": { 
    "applications": { 
      "includeApplications": [ 
        { 
          "appId": "0001111-aaaa-2222-bbbb-3333cccc4444" 
        } 
      ] 
    } 
  }, 
  "handler": { 
    "@odata.type": 
"#microsoft.graph.onFraudProtectionLoadStartExternalUsersAuthHandler", 
    "signUp": { 
      "@odata.type": "#microsoft.graph.fraudProtectionProviderConfiguration", 
      "fraudProtectionProvider": { 
        "@odata.type": "#microsoft.graph.humanSecurityFraudProtectionProvider", 
        "id": "fabe5100-cc02-46c1-bd0e-ce885fe367fd" 
      } 
    } 
  } 
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
  "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartListener",
  "id": "49eb23d9-998b-47df-a462-aa12a20ae5fb",
  "conditions": {
    "applications": {
      "includeApplications": [
        {
          "appId": "0001111-aaaa-2222-bbbb-3333cccc4444"
        }
      ]
    }
  },
  "handler": {
    "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartExternalUsersAuthHandler",
    "signUp": {
      "isContinueOnProviderErrorEnabled": false,
      "fraudProtectionProvider": {
        "@odata.type": "#microsoft.graph.humanSecurityFraudProtectionProvider",
        "id": "fabe5100-cc02-46c1-bd0e-ce885fe367fd"
      }
    }
  }
}

Beispiel 4: Erstellen eines onPasswordSubmitListener-Objekts

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.onPasswordSubmitListener",
  "displayName": "JIT migration listener",
  "conditions": {
    "applications": {
      "includeAllApplications": false,
      "includeApplications": [
        {
          "appId": "00011111-aaaa-2222-bbbb-3333cccc4444"
        }
      ]
    }
  },
  "handler": {
    "@odata.type": "#microsoft.graph.onPasswordMigrationCustomExtensionHandler",
    "migrationPropertyId": "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_requiresMigration",
    "customExtension": {
      "id": "6fc5012e-7665-43d6-9708-4370863f4e6e"
    }
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
  "@odata.type": "#microsoft.graph.onPasswordSubmitListener",
  "id": "4a6cb5f0-1234-5678-abcd-ef9012345678",
  "displayName": "JIT migration listener",
  "authenticationEventsFlowId": null,
  "conditions": {
    "applications": {
      "includeAllApplications": false,
      "includeApplications": [
        {
          "appId": "00011111-aaaa-2222-bbbb-3333cccc4444"
        }
      ]
    }
  },
  "handler": {
    "@odata.type": "#microsoft.graph.onPasswordMigrationCustomExtensionHandler",
    "migrationPropertyId": "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_requiresMigration",
    "configuration": null
  }
}

Beispiel 5: Erstellen eines onVerifiedIdClaimValidationListener-Objekts

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationListener",
  "displayName": "Verified ID Claim Validation Listener",
  "priority": 500,
  "conditions": {
    "applications": {
      "includeAllApplications": false,
      "includeApplications": [
        {
          "appId": "63856651-13d9-4784-9abf-20758d509e19"
        }
      ]
    }
  },
  "authenticationEventsFlowId": "5a8e8f57-82b2-4cbf-b145-3e6e0c154897",
  "handler": {
    "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationCustomExtensionHandler",
    "configuration": {
      "@odata.type": "#microsoft.graph.customExtensionOverwriteConfiguration",
      "clientConfiguration": {
        "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",
        "maximumRetries": 1,
        "timeoutInMilliseconds": 2000
      },
      "behaviorOnError": {
        "@odata.type": "#microsoft.graph.customExtensionBehaviorOnError"
      }
    },
    "customExtension": {
      "id": "6a0a3429-be77-0aed-951e-1c8aed62bf8a"
    }
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
    "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationListener",
    "id": "6a7455ef-0906-bbc3-f902-0f9ab8903082",
    "displayName": "Verified ID Claim Validation Listener",
    "priority": 500,
    "conditions": {
        "applications": {
            "includeAllApplications": false,
            "includeApplications": [
                {
                    "appId": "63856651-13d9-4784-9abf-20758d509e19"
                }
            ]
        }
    },
    "authenticationEventsFlowId": "5a8e8f57-82b2-4cbf-b145-3e6e0c154897",
    "handler": {
        "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationCustomExtensionHandler",
        "configuration": {
            "@odata.type": "#microsoft.graph.customExtensionOverwriteConfiguration",
            "clientConfiguration": {
                "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",
                "maximumRetries": 1,
                "timeoutInMilliseconds": 2000
            },
            "behaviorOnError": {
                "@odata.type": "#microsoft.graph.customExtensionBehaviorOnError"
            }
        },
        "customExtension": {
            "id": "6a0a3429-be77-0aed-951e-1c8aed62bf8a"
        }
    }
}