Atualizar authenticationEventsFlow

Namespace: microsoft.graph

Atualize as propriedades de um objeto authenticationEventsFlow por ID. Você deve especificar a propriedade @odata.type e o valor do tipo de objeto authenticationEventsFlow a ser atualizado. Há suporte para os seguintes subtipos derivados:

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) EventListener.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application EventListener.ReadWrite.All Indisponível.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve ser proprietário ou membro do grupo ou ser atribuído a uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. O Administrador de fluxo de usuário de ID externa é a função com menos privilégios com suporte para essa operação.

Solicitação HTTP

PATCH /identity/authenticationEventsFlows/{authenticationEventsFlow-id}

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça apenas os valores das propriedades a serem atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base nas alterações de outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Você deve incluir a propriedade @odata.type com um valor do tipo de fluxo de usuário específico no corpo. Por exemplo, "@odata.type": "#microsoft.graph.externalUsersSelfServiceSignupEventsFlow".

Propriedade Tipo Descrição
id Cadeia de caracteres O identificador exclusivo da entidade. Somente leitura.
displayName Cadeia de caracteres O nome de exibição da política de eventos.
description Cadeia de caracteres A descrição da política de eventos.
conditions authenticationConditions As condições que representam o contexto da solicitação de autenticação usada para decidir se a política de eventos é invocada.
onInteractiveAuthFlowStart onInteractiveAuthFlowStartHandler A configuração do que invocar para o evento onInteractiveAuthFlowStart.
onAuthenticationMethodLoadStart onAuthenticationMethodLoadStartHandler A configuração do que invocar para o evento onAuthenticationMethodLoadStart. Deve ter pelo menos um provedor de identidade vinculado.
onAttributeCollection onAttributeCollectionHandler A configuração do que invocar para o evento onAttributeCollection.

  • Você só poderá atualizar essa propriedade se ela tiver sido configurada durante a criação do fluxo do usuário. Se não estiver, chame primeiro a API Adicionar atributos a uma API de fluxo do usuário .
  • Você não pode adicionar ou remover atributos atualizando os objetos attributeCollectionPage>,exibições>,entradas e atributos. Use o atributo Adicionar ao fluxo do usuário ou Remover atributo das APIs de fluxo do usuário para atualizar os dois objetos.
  • Para atualizar a coleção deentradas deexibições>attributeCollectionPage>, você deve incluir todos os objetos da coleção, não apenas os objetos alterados.
  • A ordem dos objetos na coleçãode entradas deexibições>attributeCollectionPage> corresponde à ordem na qual os atributos são exibidos na IU de inscrição do aplicativo.
  • onUserCreateStart onUserCreateStartHandler A configuração do que invocar para o evento onUserCreateStart.

    Resposta

    Se tiver êxito, este método retornará um código de resposta 204 No Content. Se não for bem-sucedido, um 4xx erro será retornado com detalhes específicos.

    Exemplos

    Exemplo 1: Atualizar o nome de exibição de identidades externas Fluxo de usuário de inscrição de autoatendimento

    Solicitação

    O exemplo a seguir mostra uma solicitação que atualiza o nome de exibição de um fluxo de usuário de identidades externas específico.

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

    Resposta

    O exemplo a seguir mostra a resposta.

    HTTP/1.1 204 No Content
    

    Exemplo 2: Atualizar o layout da página de um fluxo de usuário de inscrição de autoatendimento

    A solicitação a seguir atualiza a configuração de alguns dos atributos. Todos os atributos são marcados como obrigatórios; o atributo de email está marcado como oculto; O tipo de entrada do atributo personalizado também é atualizado para um botão de opção com duas opções.

    Solicitação

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

    Resposta

    O exemplo a seguir mostra a resposta.

    HTTP/1.1 204 No Content