Update authenticationEventsFlow

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Actualice las propiedades de un objeto authenticationEventsFlow por identificador. Debe especificar la propiedad @odata.type y el valor del tipo de objeto authenticationEventsFlow para actualizar. Se admiten los siguientes subtipos derivados:

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ❌ ❌ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) EventListener.ReadWrite.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación EventListener.ReadWrite.All No disponible.

Importante

Para el acceso delegado con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe ser propietario o miembro del grupo o tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación. Id. externa Administrador de flujo de usuario es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

PATCH /identity/authenticationEventsFlows/{authenticationEventsFlow-id}

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre autenticación y autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione solo los valores de las propiedades que se van a actualizar. Las propiedades existentes que no están incluidas en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad.

En la tabla siguiente se especifican las propiedades que se pueden actualizar.

Debe incluir la propiedad @odata.type con un valor del tipo de flujo de usuario específico en el cuerpo. Por ejemplo, "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow".

Propiedad Tipo Descripción
id Cadena El identificador único de la entidad. Solo lectura.
displayName Cadena El nombre para mostrar de la directiva de eventos.
description Cadena La descripción de la directiva de eventos.
conditions condiciones de autenticación Condiciones que representan el contexto de la solicitud de autenticación que se usa para decidir si se invoca la directiva de eventos.
prioridad Int32 Prioridad a usar para cada evento individual de la directiva de eventos. Si varios oyentes que compiten entre sí para un evento tienen la misma prioridad, se elige uno y se registra un error de forma silenciosa.
onInteractiveAuthFlowStart onInteractiveAuthFlowStartHandler La configuración de qué invocar para el evento onInteractiveAuthFlowStart.
onAuthenticationMethodLoadStart onAuthenticationMethodLoadStartHandler La configuración de qué invocar para el evento onAuthenticationMethodLoadStart. Debe tener al menos un proveedor de identidades vinculado.
onAttributeCollection onAttributeCollectionHandler La configuración de qué invocar para el evento onAttributeCollection.

  • Solo puede actualizar esta propiedad si se configuró durante la creación del flujo de usuarios. Si no fue así, llame primero a la API Agregar atributos a un flujo de usuario .
  • No puede agregar o eliminar atributos actualizando los objetos attributeCollectionPage>views>,inputs y attributes. En su lugar, use las API Agregar atributo al flujo de usuario o Eliminar atributo del flujo de usuario para actualizar ambos objetos.
  • Para actualizar la colecciónde entradas de lasvistas>attributeCollectionPage>, debe incluir todos los objetos de la colección, no solo los objetos cambiados.
  • El orden de los objetos en la colección deentradas de lasvistas>attributeCollectionPage> corresponde al orden en que se muestran los atributos en la interfaz de usuario de registro de la aplicación.
  • onUserCreateStart onUserCreateStartHandler La configuración de qué invocar para el evento onUserCreateStart.

    Respuesta

    Si se ejecuta correctamente, este método devuelve un código de respuesta 204 No Content. Si no se realiza correctamente, se devuelve un 4xx error con detalles específicos.

    Ejemplos

    Ejemplo 1: Actualizar el nombre para mostrar y la prioridad de un authenticationEventsFlow

    Solicitud

    En el ejemplo siguiente se muestra una solicitud que actualiza el nombre para mostrar de un flujo de usuario de identidades externas específico, así como la prioridad de todos los agentes de escucha asociados a la directiva.

    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
    }
    

    Respuesta

    En el ejemplo siguiente se muestra la respuesta.

    HTTP/1.1 204 No Content
    

    Ejemplo 2: Actualizar el diseño de página de un flujo de usuario de registro de autoservicio

    La siguiente solicitud actualiza la configuración de algunos de los atributos. Todos los atributos se marcan como obligatorios; el atributo email está marcado como oculto; El tipo de entrada del atributo personalizado también se actualiza a un botón de radio con dos opciones.

    Solicitud

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

    Respuesta

    En el ejemplo siguiente se muestra la respuesta.

    HTTP/1.1 204 No Content