Coletar atributos de usuário personalizados durante a inscrição

  • Artigo

Se seu aplicativo voltado para o cliente exigir mais informações do que os atributos de usuário internos fornecem, você poderá adicionar seus próprios atributos. Nós nos referimos a esses atributos como atributos de usuário personalizados.

Para definir um atributo de usuário personalizado, primeiro crie o atributo no nível do locatário para que ele possa ser usado em qualquer fluxo de usuário no locatário. Em seguida, atribua o atributo ao seu fluxo de usuário de inscrição e configure como deseja que ele apareça na página de inscrição.

Saiba mais sobre atributos de usuário personalizados no artigo de atributos de perfil de usuário.

Criar atributos personalizados de usuário

  1. Entre no Centro de administração do Microsoft Entra.

  2. Se você tiver acesso a vários locatários, use o ícone Configurações no menu superior para alternar para seu locatário externo no menu Diretórios + assinaturas.

  3. Navegue até Identidade>Identidades Externas>Visão geral.

  4. Selecione Atributos de usuário personalizados. A lista contém todos os atributos de usuário disponíveis no locatário, incluindo todos os atributos personalizados de usuário que tenham sido criados. A coluna Tipo de atributo indica se um atributo é criado de forma interna ou personalizada.

  5. Selecione Adicionar. No painel Adicionar um atributo, insira um Nome para o atributo personalizado (por exemplo, "Termos de uso").

  6. Em Tipo de Dados, escolha Cadeia de caracteres, Booliano ou Inteiro, dependendo do tipo de dados e do controle de entrada do usuário que deseja criar. Os atributos de cadeia de caracteres têm um valor de tipo de entrada de usuário padrão do TextBox, mas você pode alterá-lo em uma etapa posterior (por exemplo, se você quiser configurar botões de opção ou caixas de seleção multisselecionais).

  7. (Opcional) Em Descrição, insira uma descrição do atributo personalizado para uso interno. Essa descrição não fica visível para o usuário.

    Captura de tela do painel para adicionar um atributo.

  8. Selecione Criar. O atributo personalizado agora está disponível na lista de atributos do usuário e pode ser adicionado aos fluxos de usuário.

Incluir o atributo personalizado do usuário em um fluxo de inscrição

Siga estas etapas para adicionar atributos personalizados de usuário a um fluxo de usuário que já tenha sido criado. (Se precisar criar um novo fluxo de usuário, confira Criar um fluxo de usuário de inscrição e entrada para clientes.)

  1. Entre no Centro de administração do Microsoft Entra.

  2. Se você tiver acesso a vários locatários, use o ícone Configurações no menu superior para alternar para seu locatário externo no menu Diretórios + assinaturas.

  3. Navegue atéIdentidade>Identidades Externas>Fluxos do Usuário.

  4. Selecione o fluxo de usuário na lista.

  5. Selecione Atributos do usuário. A lista inclui todos os atributos personalizados do usuário definidos conforme descrito na seção anterior. Por exemplo, o novo atributo Termos de uso agora aparece na lista. Escolha todos os atributos que deseja coletar do usuário durante a inscrição.

    Captura de tela das opções de atributo do usuário na página Criar um fluxo de usuário.

  6. Selecione Salvar.

Configure os tipos de entrada do usuário e o layout da página

Na página Layout da página, você pode indicar quais atributos são necessários e organizar a ordem de exibição. Também é possível editar rótulos de atributos, criar botões de opção ou caixas de seleção e adicionar hiperlinks para mais conteúdo (como termos de uso ou uma política de privacidade).

  1. Entre no Centro de administração do Microsoft Entra.

  2. Navegue atéIdentidade>Identidades Externas>Fluxos do Usuário.

  3. Na lista, selecione seu fluxo de usuário.

  4. Em Personalizar, selecione Layouts da página. Os atributos que você escolheu coletar aparecerão.

  5. Edite o rótulo de qualquer atributo selecionando o valor na coluna Rótulo e modificando o texto.

  6. Configurar caixas de seleção ou botões de opção:

    • Caixa de seleção única: Um tipo de atributo Booliano é renderizado como uma caixa de seleção única na página de inscrição. Para configurar o texto exibido ao lado da caixa de seleção, selecione e edite o valor na coluna Rótulo. Use a linguagem Markdown para adicionar hiperlinks. Para obter detalhes, consulte Como configurar uma caixa de seleção única (CheckboxSingleSelect)
    • Caixas de seleção múltipla: localize o atributo de tipo de dados String que você deseja configurar e selecione o valor na coluna Tipo de Entrada de Usuário para abrir o painel do editor. Escolha o tipo de entrada de usuário CheckboxMultiSelect e insira os valores. Para obter detalhes, consulte Como configurar caixas de seleção múltipla (CheckboxMultiSelect).
    • Botões de opção: localize o atributo de tipo de dados String que você deseja configurar e selecione o valor na coluna Tipo de Entrada de Usuário para abrir o painel do editor. Escolha o tipo de entrada de usuário RadioSingleSelect e insira os valores. Para mais detalhes, consulte Como configurar botões de opção (RadioSingleSelect)

  7. Altere a ordem de exibição selecionando um atributo e escolhendo Mover para cima, Mover para baixo, Mover para o topo ou Mover para o final.

  8. Torne um atributo obrigatório marcando a caixa de seleção na coluna Obrigatório. Todos os atributos podem ser marcados como obrigatórios. Para caixas de seleção múltiplas, "Obrigatório" significa que o usuário deve marcar pelo menos uma caixa de seleção.

  9. Quando todas as alterações estiverem concluídas, selecione Salvar.

Configurar uma caixa de seleção única (CheckboxSingleSelect)

Um atributo com um tipo de dados Booliano tem um tipo de entrada de usuário de CheckboxSingleSelect. Você pode modificar o texto exibido ao lado da caixa de seleção e incluir hiperlinks.

Dica

Teste agora

Para experimentar este recurso, acesse a demonstração da Woodgrove Groceries e inicie o caso de uso “Adicionar links para termos de uso e políticas de privacidade”.

Para configurar uma caixa de seleção de seleção única, siga estas etapas:

  1. Na página Layouts de Página, encontre o atributo com o tipo de dados Booliano que deseja configurar.

  2. Selecione o valor na coluna Rótulo e insira o texto que deseja exibir ao lado da caixa de seleção. Use a linguagem Markdown para adicionar hiperlinks. Por exemplo:

    • Para configurar o rótulo de um atributo Termos de uso, você pode inserir:

      I have read and agree to the [terms of use](https://woodgrove.com/terms-of-use).

    • Ou, você pode combinar seus termos de uso e política de privacidade em uma única caixa de seleção necessária:

      I have read and agree to the [terms of use](https://woodgrove.com/terms-of-use) and the [privacy policy](https://woodgrove.com/privacy).

  3. Selecione OK.

    Captura de tela da atualização do rótulo da caixa de seleção nas opções de layout da página.

  4. Na página Layouts de página, selecione Salvar.

Configurar caixas de seleção multisseleção (CheckboxMultiSelect)

Um atributo com um tipo de dados String pode ser configurado como um tipo de entrada de usuário CheckboxMultiSelect, que é uma série de uma ou mais caixas de seleção que aparecem sob o rótulo do atributo. O usuário pode selecionar uma ou mais caixas de seleção. Você pode definir o texto das caixas de seleção individuais e incluir hiperlinks para outros conteúdos. Tornar esse atributo "Obrigatório" significa que o usuário deve marcar pelo menos uma das caixas de seleção.

  1. Na página Layouts de Página, encontre o atributo com o tipo de dados de String que deseja configurar como uma série de caixas de seleção.

  2. Selecione o valor na coluna Rótulo e insira o título que deseja exibir acima da série de caixas de seleção, por exemplo, How did you hear about us?.

  3. Selecione o valor na coluna Tipo de entrada do usuário para abrir o painel do editor.

  4. No painel do editor, em Tipo de entrada de usuário, selecione CheckboxMultiSelect.

  5. Para cada caixa de seleção que gostaria de adicionar, inicie uma nova linha e insira as seguintes informações:

    • Em Texto, insira o texto que deseja exibir ao lado da caixa de seleção. Use a linguagem Markdown para adicionar hiperlinks.

    • Em Valores, insira um valor que será gravado no objeto do usuário e retornado como declarações se o usuário selecionar a caixa de seleção.

  6. Selecione OK.

    Captura de tela da adição de uma caixa de seleção de seleção múltipla a um atributo de cadeia de caracteres nas opções de layout da página.

  7. Na página Layouts de página, selecione Salvar.

Configurar botões de opção (RadioSingleSelect)

Um atributo com um tipo de dados String pode ser configurado como um tipo de entrada de usuário RadioSingleSelect, que é uma série de botões de opção que aparecem sob o rótulo do atributo. O usuário pode selecionar apenas um botão de opção. Você pode definir o texto dos botões de opção individuais e incluir hiperlinks para outros conteúdos.

  1. Na página Layouts de página, encontre o atributo com o tipo de dados de Cadeia de caracteres que deseja configurar como um botão de opção ou uma série de botões de opção.

  2. Selecione o valor na coluna Rótulo e insira o título que deseja exibir acima da série de botões de opção, por exemplo, Sweatshirt size.

  3. Selecione o valor na coluna Tipo de entrada do usuário para abrir o painel do editor.

  4. No painel do editor, em Tipo de entrada do usuário, selecione RadioSingleSelect.

  5. Para cada botão de opção que você gostaria de adicionar, inicie uma nova linha e insira as informações a seguir:

    • Em Texto, insira o texto que deseja exibir ao lado do botão de opção. Use a linguagem Markdown para adicionar hiperlinks.

    • Em Valores, insira um valor que será gravado no objeto do usuário e retornado como declarações se o usuário selecionar o botão de opção.

  6. Selecione OK.

    Captura de tela da adição de um botão de opção a um atributo de cadeia de caracteres nas opções de layout da página.

  7. Na página Layouts de página, selecione Salvar.

Localizar a ID do aplicativo para o aplicativo de extensões

Atributos de usuário personalizados são armazenados em um aplicativo chamado b2c-extensions-app. Depois que um usuário insere um valor para o atributo personalizado durante a inscrição, ele é adicionado ao objeto de usuário e pode ser chamado por meio da API do Microsoft Graph usando a convenção de nomenclatura extension_{appId-without-hyphens}_{custom-attribute-name} onde:

  • {appId-without-hyphens} é a versão removida da ID do cliente para o b2c-extensions-app.
  • {custom-attribute-name} é o nome atribuído ao atributo personalizado.

Use estas etapas para localizar a ID do aplicativo de extensões:

  1. Entre no Centro de administração do Microsoft Entra.
  2. Navegue até Identidade>Registros de aplicativo>Todos os aplicativos
  3. Selecione o aplicativo b2c-extensions-app. Não modifique. Usado pelo AADB2C para armazenar dados do usuário.
  4. Na página Visão geral , use o valor da ID do aplicativo (cliente), por exemplo: 12345678-abcd-1234-1234-ab123456789, mas remova os hifens.

Por exemplo, se você criar um atributo personalizado chamado loyaltyNumber, consulte-o como extension_12345678abcd12341234ab123456789_loyaltyNumber

Adicionar atributos de usuário personalizados ao token de ID

Quando os usuários se conectarem ao seu aplicativo, o aplicativo receberá um token de ID, que inclui os detalhes do usuário. Esses detalhes são chamados de declarações de token. Se necessário, você pode incluir um atributo de usuário personalizado para estar disponível como uma declaração no token de ID retornado ao seu aplicativo. Para fazer isso, siga as etapas no artigo Adicionar atributos ao token de ID retornado ao seu aplicativo.

Próximas etapas

Adicione atributos ao token de ID retornado ao seu aplicativo .

Criar um fluxo de inscrição e entrada de usuário para clientes.