Partilhar via


Adicionar atributo (ao fluxo de utilizador)

Namespace: microsoft.graph

Adicione um atributo a um fluxo de utilizador de inscrição personalizada de identidades externas representado por um objeto externalUsersSelfServiceSignupEventsFlow . Pode adicionar atributos personalizados e incorporados a um fluxo de utilizador.

O atributo é adicionado aosatributosattributeCollection> e às coleções devistasattributeCollectionPage>do atributoCollection> no fluxo de utilizador. Na coleção de vistas , o atributo é atribuído às predefinições. Pode corrigir o fluxo de utilizador para personalizar as definições do atributo no objeto de vistas , por exemplo, marcá-lo como necessário ou atualizar os tipos de entrada permitidos.

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

POST /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

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 uma propriedade odata.id com o ID do objeto identityUserFlowAttribute para adicionar ao fluxo de utilizador.

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

Solicitação

O exemplo seguinte mostra um pedido que adiciona cidade como um atributo para o passo de recolha de atributos de um fluxo de utilizador de inscrição self-service de identidades externas. Se o pedido for bem-sucedido, o atributo é adicionado aosatributosattributeCollection> e às coleções devistasattributeCollection>AttributeCollectionPage> no fluxo de utilizador. Depois de adicionar o atributo ao fluxo de utilizador, pode APLICAR PATCH ao fluxo de utilizador para personalizar as definições do atributo no objeto de vistas , ou seja, personalizar o esquema de página.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventsFlows/0313cc37-d421-421d-857b-87804d61e33e/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref

{
    "@odata.id":"https://graph.microsoft.com/v1.0/identity/userFlowAttributes/city"
} 

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content