Atributos de perfil de utilizador
Aplica-se a:
Locatários da força de
trabalho Locatários externos (saiba mais)
Os atributos de usuário coletados durante a inscrição são armazenados com o perfil do usuário em seu diretório. Você pode escolher entre atributos de usuário internos ou criar atributos de usuário personalizados.
Atributos de usuário internos, como cidade, país/região, endereço de email e assim por diante, estão disponíveis na ID Externa do Microsoft Entra. Você pode escolher os atributos de usuário internos que deseja coletar durante a inscrição.
Para qualquer informação adicional que você queira coletar, você pode criar atributos de usuário personalizados. Vários controles de entrada personalizados podem ser adicionados à página de inscrição para coletar os atributos, incluindo caixas de texto, botões de opção e caixas de seleção. O exemplo a seguir mostra como os controles de entrada personalizados podem ser usados para coletar atributos para número de fidelidade, consentimento de termos de uso para termos de uso e consentimento de política de privacidade.
Atributos de usuário internos
O Microsoft Entra External ID tem atributos de usuário internos que você pode coletar durante a inscrição. Você configura esses atributos quando cria fluxos de usuário no centro de administração do Microsoft Entra.
Esta tabela resume os atributos de usuário internos que você pode coletar durante o fluxo de inscrição:
- Rótulo no centro de administração do Microsoft Entra é o nome do atributo de usuário como ele aparece no centro de administração do Microsoft Entra.
- Nome programável é o nome do atributo de usuário usado no recurso de usuário da API do Microsoft Graph. Você usa esse nome quando deseja usar esse atributo de usuário programaticamente, como na autenticação nativa.
- Tipo de dados é o tipo de dados do atributo de usuário.
| Rótulo no centro de administração do Microsoft Entra | Nome programável | Tipo de dados | Observações |
|---|---|---|---|
| City | cidade | String | O comprimento máximo é de 128 caracteres. |
| País/Região | país/região | String | O comprimento máximo é de 128 caracteres. |
| Nome a apresentar | displayName | String | O comprimento máximo é de 256 caracteres. |
| Endereço de E-mail | correio | String | Esta propriedade não pode conter caracteres de destaque. Na API de autenticação nativa, esse atributo é referenciado como nome de usuário. |
| Nome Próprio | givenName | String | O comprimento máximo é de 64 caracteres. |
| Cargo | jobTitle | String | O comprimento máximo é de 128 caracteres. |
| Código Postal | postalCode | String | O comprimento máximo é de 40 caracteres. |
| Distrito | state | String | O comprimento máximo é de 128 caracteres. |
| Rua | streetAddress | String | O comprimento máximo é de 1024 caracteres. |
| Apelido | surname | String | O comprimento máximo é de 64 caracteres. |
Atributos de usuário personalizados
Se seu aplicativo exigir mais informações do que os atributos de usuário internos fornecem, você poderá adicionar seus próprios atributos. Referimo-nos 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 possa ser usado em qualquer fluxo de usuário no locatário. Em seguida, você atribui o atributo ao fluxo de usuário de inscrição e configura como deseja que ele apareça na página de inscrição.
Saiba como criar atributos de usuário personalizados Criar artigo de atributos de usuário personalizados.
Tipos de entrada de atributos de usuário personalizados
Antes de usar atributos de usuário personalizados, determine a melhor maneira de coletar a entrada do usuário para cada atributo personalizado que você deseja coletar. Você pode coletar informações de seus usuários durante a inscrição usando os seguintes controles de tipo de entrada:
- Caixa de texto String
- Botões de opção
- Caixas de seleção de seleção múltipla
- Caixa de texto numérica
- Caixa de seleção de seleção única
Consulte esta tabela para encontrar os tipos de dados apropriados e os tipos de entrada do usuário:
| Tipo de dados | Tipo de entrada do usuário | Description |
|---|---|---|
| String | TextBox | Campo de entrada de texto de forma livre. |
| String | RadioSingleSelect | Série de botões de opção com apenas uma seleção permitida. O texto para botões de opção individuais pode incluir hiperlinks formatados na linguagem Markdown. |
| String | Caixa de seleçãoMultiSelect | Série de uma ou mais caixas de seleção com várias seleções permitidas. As caixas de seleção Texto para individuais podem incluir hiperlinks formatados no idioma Markdown. |
| Boolean | Caixa de seleçãoSeleção única | Caixa de seleção booleana única com um rótulo. A caixa de seleção Rótulo pode incluir hiperlinks formatados no idioma Markdown. |
| Int | NumericTextBox | Entrada inteira de forma livre. |
As caixas de seleção e os botões de opção podem incluir hiperlinks para outros conteúdos, como termos de uso e políticas de privacidade. O exemplo no início deste artigo mostra uma página de inscrição que combina atributos internos e atributos personalizados. No exemplo:
- O campo Nome para Exibição é um atributo interno.
- O Número de Fidelidade é um atributo personalizado com um campo de entrada de forma livre que aceita um inteiro numérico. Você pode configurar esse formato usando o tipo de dados Int e o tipo de entrada de usuário NumericTextBox.
- Os atributos personalizados dos termos de uso e da política de privacidade são caixas de seleção separadas e de seleção única com rótulos contendo hiperlinks. Você pode configurar uma única caixa de seleção usando o tipo de dados booleano , que assume como padrão o tipo de entrada de usuário CheckboxSingleSelect . Use o idioma de marcação para adicionar hiperlinks ao rótulo da caixa de seleção.
Saiba como configurar seus tipos de entrada de atributos de usuário no artigo Configurar os tipos de entrada do usuário.
Onde os atributos de usuário personalizados são armazenados
Os atributos de usuário personalizados também são conhecidos como atributos de extensão de diretório porque estendem as informações de perfil de usuário armazenadas em seu diretório. Todos os atributos de extensão para seu locatário externo 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 extension_{appId-without-hyphens}_{custom-attribute-name} de nomenclatura onde:
{appId-without-hyphens}é a versão removida do ID do cliente para o b2c-extensions-app.{custom-attribute-name}é o nome que você atribuiu ao atributo personalizado.
Por exemplo, se o ID do cliente do b2c-extensions-app for 2588a-bcdwh-tfeehj-jeeqw-ertc e o nome do atributo for:
- loyaltyNumber, em seguida, o atributo personalizado é nomeado como
extension_2588abcdwhtfeehjjeeqwertc_loyaltyNumber. - Número de fidelidade, em seguida, o atributo personalizado é nomeado como
extension_2588abcdwhtfeehjjeeqwertc_loyaltyNumber. Você remove o espaço e usa camel case para separar as palavras.
Use o artigo Localizar a ID do aplicativo de extensões para saber como encontrar a ID do aplicativo para o aplicativo b2c-extensions-registrado em seu locatário externo.
Microsoft Graph APIs
Os atributos de usuário são chamados de atributos de fluxo de usuário no Microsoft Graph. Use o tipo de recurso identityUserFlowAttribute e seus métodos associados para gerenciar atributos de fluxo de usuário internos e personalizados.