Mettre à jour authenticationEventsFlow

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Mettre à jour les propriétés d’un objet authenticationEventsFlow par ID. Vous devez spécifier la propriété @odata.type et la valeur du type d’objet authenticationEventsFlow à mettre à jour. Les sous-types dérivés suivants sont pris en charge :

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ❌ ❌ ✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) EventListener.ReadWrite.All Non disponible.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application EventListener.ReadWrite.All Non disponible.

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit être propriétaire ou membre du groupe ou disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. ID externe : Administrateur de flux utilisateur est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

PATCH /identity/authenticationEventsFlows/{authenticationEventsFlow-id}

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Vous devez inclure la propriété @odata.type avec une valeur du type de flux utilisateur spécifique dans le corps. Par exemple : "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow".

Propriété Type Description
id String Identifiant unique de l’entité. En lecture seule.
displayName String Nom complet de la stratégie d’événements.
description String Description de la stratégie d’événements.
conditions authenticationConditions Conditions représentant le contexte de la demande d’authentification utilisée pour décider si la stratégie d’événements est appelée.
priorité Int32 Priorité à utiliser pour chaque événement individuel de la stratégie d’événements. Si plusieurs écouteurs concurrents pour un événement ont la même priorité, l’un d’entre eux est choisi et une erreur est consignée silencieusement.
onInteractiveAuthFlowStart onInteractiveAuthFlowStartHandler Configuration de ce qu’il faut appeler pour l’événement onInteractiveAuthFlowStart.
onAuthenticationMethodLoadStart onAuthenticationMethodLoadStartHandler Configuration de ce qu’il faut appeler pour l’événement onAuthenticationMethodLoadStart. Au moins un fournisseur d’identité doit être lié.
onAttributeCollection onAttributeCollectionHandler Configuration de ce qu’il faut appeler pour l’événement onAttributeCollection.

  • Vous ne pouvez mettre à jour cette propriété que si elle a été configurée lors de la création du flux utilisateur. Si ce n’est pas le cas, appelez d’abord l’API Ajouter des attributs à un flux utilisateur .
  • Vous ne pouvez pas ajouter ou supprimer des attributs en mettant à jour les objets attributeCollectionPage>views>,inputs et attributs. Utilisez plutôt l’API Ajouter un attribut au flux utilisateur ou Supprimer l’attribut du flux utilisateur pour mettre à jour les deux objets.
  • Pour mettre à jour la collectiond’entrées desaffichages>attributeCollectionPage>, vous devez inclure tous les objets de la collection, et pas seulement les objets modifiés.
  • L’ordre des objets dans la collectiond’entrées desaffichages>attributeCollectionPage> correspond à l’ordre dans lequel les attributs sont affichés sur l’interface utilisateur d’inscription de l’application.
    		•
    onUserCreateStart onUserCreateStartHandler Configuration de ce qu’il faut appeler pour l’événement onUserCreateStart.

    Réponse

    Si elle réussit, cette méthode renvoie un code de réponse 204 No Content. En cas d’échec, une 4xx erreur est renvoyée avec des détails spécifiques.

    Exemples

    Exemple 1 : mise à jour du nom d’affichage et de la priorité d’un authenticationEventsFlow

    Demande

    L’exemple suivant montre une demande qui met à jour le nom d’affichage d’un flux d’utilisateurs d’identités externes spécifique, ainsi que la priorité de tous les écouteurs associés à la stratégie.

    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
}

    Réponse

    L’exemple suivant illustre la réponse.

    HTTP/1.1 204 No Content

    Exemple 2 : mise à jour de la mise en page d’un flux utilisateur d’inscription en libre-service

    La demande suivante met à jour la configuration de certains attributs. Tous les attributs sont marqués comme obligatoires ; l’attribut e-mail est marqué comme masqué ; Le type d’entrée de l’attribut personnalisé est également mis à jour vers une case d’option avec deux options.

    Demande

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

    Réponse

    L’exemple suivant illustre la réponse.

    HTTP/1.1 204 No Content
    • Dernière mise à jour :