Partilhar via


Atualizar authenticationEventsFlow

Namespace: microsoft.graph

Atualize as propriedades de um objeto authenticationEventsFlow por ID. Tem de especificar a propriedade @odata.type e o valor do tipo de objeto authenticationEventsFlow a atualizar. São suportados os seguintes subtipos derivados:

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
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

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ser proprietário ou membro do grupo ou ser-lhe atribuída uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. ID externa Administrador de Fluxo de Utilizador é a função com menos privilégios suportada para esta 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 do pedido, forneça apenas os valores das propriedades a atualizar. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade.

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

Tem de incluir a propriedade @odata.type com um valor do tipo de fluxo de utilizador 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 a apresentar 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 do pedido de autenticação que é utilizado 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. Tem de ter, pelo menos, um fornecedor de identidade ligado.
onAttributeCollection onAttributeCollectionHandler A configuração do que invocar para o evento onAttributeCollection.

  • Só pode atualizar esta propriedade se tiver sido configurada durante a criação do fluxo de utilizador. Se não tiver sido, chame primeiro a API Adicionar atributos a um fluxo de utilizador .
  • Não pode adicionar ou remover atributos ao atualizar osobjetos de atributose entradas devistas>de PáginaCollectionPage>. Utilize o fluxo Adicionar atributo ao utilizador ou Remover atributo das APIs de fluxo de utilizador para atualizar ambos os objetos.
  • Para atualizar a coleção deentradas devistas>attributeCollectionPage>, tem de incluir todos os objetos na coleção e não apenas os objetos alterados.
  • A ordem dos objetos na coleção deentradas devistas>attributeCollectionPage> corresponde à ordem pela qual os atributos são apresentados na IU de inscrição da aplicação.
  • 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, é devolvido um 4xx erro com detalhes específicos.

    Exemplos

    Exemplo 1: Atualizar o nome a apresentar de um fluxo de utilizador de inscrição self-service de identidades externas

    Solicitação

    O exemplo seguinte mostra um pedido que atualiza o nome a apresentar de um fluxo de utilizador 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",
    }
    

    Resposta

    O exemplo a seguir mostra a resposta.

    HTTP/1.1 204 No Content
    

    Exemplo 2: Atualizar o esquema de página de um fluxo de utilizador de inscrição self-service

    O pedido seguinte atualiza a configuração de alguns dos atributos. Todos os atributos são marcados como necessários; o atributo de e-mail 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