Freigeben über

Aktualisieren von authenticationEventsFlow

  • Artikel

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Aktualisieren Sie die Eigenschaften eines authenticationEventsFlow-Objekts anhand der ID. Sie müssen die @odata.type-Eigenschaft und den Wert des zu aktualisierenden authenticationEventsFlow-Objekttyps angeben. Die folgenden abgeleiteten Untertypen werden unterstützt:

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
Anwendung EventListener.ReadWrite.All Nicht verfügbar.

Wichtig

In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss der angemeldete Benutzer Besitzer oder Mitglied der Gruppe sein oder einer unterstützten Microsoft Entra Rolle oder einer benutzerdefinierten Rolle mit einer unterstützten Rollenberechtigung zugewiesen sein. External ID Benutzerflowadministrator ist die Rolle mit den geringsten Berechtigungen, die für diesen Vorgang unterstützt wird.

HTTP-Anforderung

PATCH /identity/authenticationEventsFlows/{authenticationEventsFlow-id}

Anforderungsheader

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

Anforderungstext

Geben Sie im Anforderungstext nur die Werte für zu aktualisierende Eigenschaften an. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.

In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.

Sie müssen die @odata.type-Eigenschaft mit einem Wert des bestimmten Benutzerflowtyps in den Text einschließen. Beispiel: "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow".

Eigenschaft Typ Beschreibung
id String Der eindeutige Bezeichner für die Entität. Schreibgeschützt.
displayName String Der Anzeigename für die Ereignisrichtlinie.
description String Die Beschreibung der Ereignisrichtlinie.
Bedingungen authenticationConditions Die Bedingungen, die den Kontext der Authentifizierungsanforderung darstellen, mit der entschieden wird, ob die Ereignisrichtlinie aufgerufen wird.
Priorität Int32 Die Priorität, die für jedes einzelne Ereignis der Ereignisrichtlinie verwendet werden soll. Wenn mehrere konkurrierende Listener für ein Ereignis dieselbe Priorität haben, wird ein Listener ausgewählt, und ein Fehler wird automatisch protokolliert.
onInteractiveAuthFlowStart onInteractiveAuthFlowStartHandler Die Konfiguration, die für das onInteractiveAuthFlowStart-Ereignis aufgerufen werden soll.
onAuthenticationMethodLoadStart onAuthenticationMethodLoadStartHandler Die Konfiguration, die für das onAuthenticationMethodLoadStart-Ereignis aufgerufen werden soll. Es muss mindestens ein Identitätsanbieter verknüpft sein.
onAttributeCollection onAttributeCollectionHandler Die Konfiguration, die für das onAttributeCollection-Ereignis aufgerufen werden soll.

  • Sie können diese Eigenschaft nur aktualisieren, wenn sie während der Erstellung des Benutzerflows konfiguriert wurde. Wenn dies nicht der Fall ist, rufen Sie zuerst die API Add attribute to a user flow (Attribute zu einem Benutzerflow hinzufügen) auf.
  • Sie können keine Attribute hinzufügen oder entfernen, indem Sie dieAttributeCollectionPage-Ansichteneingaben>> und Attribute-Objekte aktualisieren. Verwenden Sie stattdessen die APIs Attribut zum Benutzerflow hinzufügen oder Attribut aus Benutzerflow entfernen , um beide Objekte zu aktualisieren.
  • Um dieEingabeauflistungattributeCollectionPage-Ansichten>> zu aktualisieren, müssen Sie alle Objekte in die Auflistung einschließen, nicht nur die geänderten Objekte.
  • Die Reihenfolge der Objekte in der Eingabesammlung attributeCollectionPage-Ansichten>> entspricht der Reihenfolge, in der die Attribute auf der Registrierungsbenutzeroberfläche der App angezeigt werden.
    		•
    onUserCreateStart onUserCreateStartHandler Die Konfiguration für den Aufruf für das onUserCreateStart-Ereignis.

    Antwort

    Wenn die Methode erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben. Wenn der Fehler nicht erfolgreich ist, wird ein 4xx Fehler mit bestimmten Details zurückgegeben.

    Beispiele

    Beispiel 1: Aktualisieren des Anzeigenamens und der Priorität eines authenticationEventsFlow

    Anforderung

    Das folgende Beispiel zeigt eine Anforderung, die den Anzeigenamen eines bestimmten Benutzerflows für externe Identitäten sowie die Priorität für alle listener aktualisiert, die der Richtlinie zugeordnet sind.

    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
}

    Antwort

    Das folgende Beispiel zeigt die Antwort.

    HTTP/1.1 204 No Content

    Beispiel 2: Aktualisieren des Seitenlayouts eines Benutzerflows für die Self-Service-Registrierung

    Die folgende Anforderung aktualisiert die Konfiguration einiger Attribute. Alle Attribute sind als erforderlich gekennzeichnet. das E-Mail-Attribut als ausgeblendet markiert ist; Der Eingabetyp des benutzerdefinierten Attributs wird ebenfalls in ein Optionsfeld mit zwei Optionen aktualisiert.

    Anforderung

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

    Antwort

    Das folgende Beispiel zeigt die Antwort.

    HTTP/1.1 204 No Content