Atributos de perfil do usuário
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ê deseja 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
A ID Externa do Microsoft Entra tem atributos de usuário internos que você pode coletar durante a inscrição. Você configura esses atributos ao criar 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, conforme usado no recurso de usuário da API do Microsoft Graph. Use esse nome quando quiser usar esse atributo de usuário programaticamente, como em autenticação nativa.
- Tipo de dados é o tipo de dados do atributo do usuário.
Rótulo no centro de administração do Microsoft Entra | Nome programável | Tipo de dados | Comentários |
---|---|---|---|
City | cidade | String | O comprimento máximo é de 128 caracteres. |
País/Região | country | String | O comprimento máximo é de 128 caracteres. |
Nome para Exibição | displayName | String | O comprimento máximo é de 256 caracteres. |
Endereço de Email | String | Essa propriedade não pode conter caracteres de acento. Na API de autenticação nativa, esse atributo é referenciado como nome de usuário. | |
Nome | 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. |
Estado/Província | estado | String | O comprimento máximo é de 128 caracteres. |
Endereço | streetAddress | String | O comprimento máximo é de 1024 caracteres. |
Sobrenome | sobrenome | String | O comprimento máximo é de 64 caracteres. |
Atributos de usuário personalizados
Se o seu aplicativo exigir mais informações do que os atributos de usuário internos fornecerem, 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 como criar atributos de usuário personalizados no artigoCriar 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 de cadeia de caracteres
- Botões de opção
- Caixas de seleção múltipla
- Caixa de texto numérica
- Caixa de seleção de seleção única
Consulte esta tabela para localizar os tipos de dados apropriados e os tipos de entrada do usuário:
Tipo de dados | Tipo de entrada de usuário | Descrição |
---|---|---|
String | TextBox | Campo de entrada de texto de formato 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 em linguagem Markdown. |
String | CheckboxMultiSelect | Série de uma ou mais caixas de seleção com várias seleções permitidas. O texto para caixas de seleção individuais pode incluir hiperlinks formatados em linguagem Markdown. |
Booliano | CheckboxSingleSelect | Caixa de seleção booliana única com um rótulo. O rótulo para caixas de seleção individuais pode incluir hiperlinks formatados em linguagem Markdown. |
Int | NumericTextBox | Entrada de inteiro de forma livre. |
Caixas de seleção e 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 de Exibição é um atributo interno.
- O Número de Fidelidade é um atributo personalizado com um campo de entrada de forma livre que aceita um número inteiro numérico. É possível configurar esse formato usando o tipo de dados Int e o tipo de entrada de usuário NumericTextBox.
- Os termos de uso e os atributos personalizados da política de privacidade são caixas de seleção separadas e de seleção única com rótulos contendo hiperlinks. É possível configurar uma caixa de seleção única usando o tipo de dados Booliano, cujo padrão é o tipo de entrada de usuário CheckboxSingleSelect. Use a linguagem Markdown para adicionar hiperlinks ao rótulo da caixa de seleção.
Saiba como configurar os tipos de entrada de atributos de usuário no artigo Configurar os tipos de entrada do usuário.
Em que local os atributos personalizados do usuário são armazenados
Os atributos personalizados de usuário também são conhecidos como atributos de extensão de diretório porque estendem as informações do perfil de usuário armazenadas no diretório. Todos os atributos de extensão do 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 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.
Por exemplo, se a ID do cliente do b2c-extensions-app estiver 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 o atributo personalizado é nomeado como
extension_2588abcdwhtfeehjjeeqwertc_loyaltyNumber
. Você remove o espaço e usa maiúsculas e minúsculas para separar as palavras.
Use o artigo Encontrar o ID do aplicativo para o aplicativo de extensões para saber como encontrar o ID do aplicativo para o b2c-extensions-appregistrado em seu locatário externo.
APIs do Microsoft Graph
Os atributos de usuário são conhecidos como 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.