Actualizar authenticationEventsFlow

  • Artículo

Espacio de nombres: microsoft.graph

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

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ❌ ❌ ❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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

En escenarios delegados con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe ser propietario o miembro del grupo o tener asignado un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. 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 la autenticación y la 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 se incluyen 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 Identificador único de la entidad. Solo lectura.
displayName Cadena Nombre para mostrar de la directiva de eventos.
description Cadena Descripción de la directiva de eventos.
conditions authenticationConditions Condiciones que representan el contexto de la solicitud de autenticación que se usa para decidir si se invoca la directiva de eventos.
onInteractiveAuthFlowStart onInteractiveAuthFlowStartHandler Configuración de qué invocar para el evento onInteractiveAuthFlowStart.
onAuthenticationMethodLoadStart onAuthenticationMethodLoadStartHandler Configuración de qué invocar para el evento onAuthenticationMethodLoadStart. Debe tener al menos un proveedor de identidades vinculado.
onAttributeCollection onAttributeCollectionHandler Configuración de lo que se va a invocar para el evento onAttributeCollection.

  • Solo puede actualizar esta propiedad si se configuró durante la creación del flujo de usuario. Si no es así, llame primero a add attributes to a user flow API (Agregar atributos a una API de flujo de usuario ).
  • No se pueden agregar ni quitar atributos actualizando los objetosde entradas y atributos delas vistas>attributeCollectionPage>. Use add attribute to user flow (Agregar atributo al flujo de usuario ) o Remove attribute from user flow API (Quitar atributo de las API de flujo de usuario ) en su lugar para actualizar ambos objetos.
  • Para actualizar la colección deentradas devistas>attributeCollectionPage>, debe incluir todos los objetos de la colección, no solo los objetos modificados.
  • El orden de los objetos de la colecciónde entradas devistas>attributeCollectionPage> corresponde al orden en que se muestran los atributos en la interfaz de usuario de registro de la aplicación.
    		•
    onUserCreateStart onUserCreateStartHandler Configuración de lo que se va a 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 ejecuta correctamente, se devuelve un 4xx error con detalles específicos.

    Ejemplos

    Ejemplo 1: Actualización del nombre para mostrar de un flujo de usuario de registro de autoservicio de identidades externas

    Solicitud

    En el ejemplo siguiente se muestra una solicitud que actualiza el nombre para mostrar de un flujo de usuario de identidades externas específicas.

    PATCH https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
  "displayName": "New user flow description",
}

    Respuesta

    En el ejemplo siguiente se muestra la respuesta.

    HTTP/1.1 204 No Content

    Ejemplo 2: Actualización del 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/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignUpEventsFlow",
    "onAttributeCollection": {
        "@odata.type": "#microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp",
        "attributeCollectionPage": {
            "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