Definir atributos personalizados no Azure Active Directory B2C

Importante

A partir de 1º de maio de 2025, o Azure AD B2C não estará mais disponível para compra para novos clientes. Saiba mais em nossas perguntas frequentes.

Antes de começar, use o seletor Escolha um tipo de política na parte superior dessa página para escolher o tipo de política que você está configurando. O Azure Active Directory B2C oferece dois métodos para definir como os usuários interagem com seus aplicativos: por meio de fluxos de usuários predefinidos ou por meio de políticas personalizadas totalmente configuráveis. As etapas necessárias neste artigo são diferentes para cada método.

No artigo Adicionar declarações e personalizar a entrada do usuário usando políticas personalizadas , você aprenderá a usar atributos de perfil de usuário internos. Neste artigo, você habilita um atributo personalizado no diretório do Azure AD B2C (Azure Active Directory B2C). Posteriormente, você pode usar o novo atributo como uma declaração personalizada em fluxos de usuário ou políticas personalizadas simultaneamente.

Seu diretório do Azure AD B2C vem com um conjunto interno de atributos. No entanto, você geralmente precisa criar seus próprios atributos para gerenciar seu cenário específico, por exemplo, quando:

Um aplicativo voltado para o cliente precisa persistir um atributo loyaltyId .
Um provedor de identidade tem um identificador de usuário exclusivo, uniqueUserGUID, que deve ser mantido.
Um percurso personalizado do usuário precisa manter o estado do usuário, migrationStatus, para que outras lógicas possam operar sobre ele.

Propriedade de extensão, atributo personalizado e declaração personalizada referem-se à mesma coisa no contexto deste artigo. O nome varia dependendo do contexto, como aplicativo, objeto ou política.

O Azure AD B2C permite estender o conjunto de atributos armazenados em cada conta de usuário. Você também pode ler e gravar esses atributos usando a API do Microsoft Graph.

Pré-requisitos

Criar um fluxo do usuário para que os usuários podem se registrar e entrar no seu aplicativo.
Registrar um aplicativo da web.

Conclua as etapas em Comece a usar políticas personalizadas no Active Directory B2C. Esse tutorial mostra como atualizar arquivos de política personalizados para usar sua configuração de locatário do Azure AD B2C.
Registrar um aplicativo da web.

Como criar um atributo personalizado

Entre no portal do Azure pelo menos como Administrador de Atributo de Fluxo de Usuário de ID Externa do locatário do Azure AD B2C.
Se você tiver acesso a vários locatários, selecione o ícone Configurações no menu superior para alternar para seu locatário do Azure AD B2C no menu Diretórios + assinaturas.
Escolha Todos os serviços no canto superior esquerdo do portal do Azure, pesquise e selecione O Azure AD B2C.
Selecione atributos de usuário e, em seguida, selecione Adicionar.
Forneça um nome para o atributo personalizado (por exemplo, "ShoeSize")
Escolha um tipo de dados. Somente Cadeia de caracteres, Boolean e Int estão disponíveis.
Opcionalmente, insira uma Descrição para fins informativos.
Selecione Criar.

O atributo personalizado agora está disponível na lista de atributos de usuário e para uso em seus fluxos de usuário. Um atributo personalizado só é criado na primeira vez em que é usado em qualquer fluxo de usuário e não quando você o adiciona à lista de atributos de usuário.

Usar um atributo personalizado no fluxo do usuário

No locatário do Azure AD B2C, selecione Fluxos dos usuários.
Selecione sua política (por exemplo, "B2C_1_SignupSignin") para abri-la.
Selecione atributos de usuário e selecione o atributo personalizado (por exemplo, "ShoeSize"). Clique em Salvar.
Selecione declarações de aplicativo e, em seguida, selecione o atributo personalizado.
Clique em Salvar.

Depois de criar um novo usuário usando o fluxo de usuário, você pode usar o recurso Executar fluxo de usuário no fluxo do usuário para verificar a experiência do cliente. Agora você deve ver ShoeSize na lista de atributos coletados durante o processo de inscrição, e ele estará presente no token enviado de volta ao seu aplicativo.

Aplicativo de extensões do Azure AD B2C

Atributos de extensão só podem ser registrados em um objeto de aplicativo, mesmo que possam conter dados para um usuário. O atributo de extensão é anexado ao aplicativo chamado b2c-extensions-app. Não modifique esse aplicativo, pois ele é usado pelo Azure AD B2C para armazenar dados do usuário. Você pode encontrar esse aplicativo no Azure AD B2C, registros de aplicativo.

Obter a ID de aplicativo do aplicativo de extensões

Entre no portal do Azure.
Se você tiver acesso a vários locatários, selecione o ícone Configurações no menu superior para alternar para seu locatário do Azure AD B2C no menu Diretórios + assinaturas.
No menu à esquerda, selecione Azure AD B2C. Ou selecione Todos os serviços e pesquise e selecione Azure AD B2C.
Selecione registros de aplicativo e selecione Todos os aplicativos.
Selecione o b2c-extensions-app. Do not modify. Used by AADB2C for storing user data. aplicativo.
Copie a ID do aplicativo. Exemplo: 00001111-aaaa-2222-bbbb-3333cccc4444.

Obter as propriedades de aplicativo do aplicativo de extensões

Entre no portal do Azure.
Se você tiver acesso a vários locatários, selecione o ícone Configurações no menu superior para alternar para seu locatário do Azure AD B2C no menu Diretórios + assinaturas.
No menu à esquerda, selecione Azure AD B2C. Ou selecione Todos os serviços e pesquise e selecione Azure AD B2C.
Selecione registros de aplicativo e selecione Todos os aplicativos.
Selecione o b2c-extensions-app. Não modifique. Usado pelo AADB2C para armazenar dados do usuário. aplicação.
Copiar os identificadores a seguir para a sua área de transferência e salve-os:
- ID do aplicativo. Exemplo: 00001111-aaaa-2222-bbbb-3333cccc4444.
- ID do objeto. Exemplo: aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb.

Modificar sua política personalizada

Para habilitar atributos personalizados em sua política, forneça a ID do Aplicativo e a ID do Objeto do Aplicativo nos metadados do perfil técnico AAD-Common . O perfil técnico do AAD-Common* é encontrado no perfil técnico base do Microsoft Entra ID e fornece suporte para o gerenciamento de usuários do Microsoft Entra. Outros perfis técnicos do Microsoft Entra ID incluem o AAD-Common para usar sua configuração. Substitua esse perfil técnico do AAD-Common no arquivo de extensão.

Abra o arquivo de extensões da política. Por exemplo, SocialAndLocalAccounts/TrustFrameworkExtensions.xml.
Localize o elemento ClaimsProviders. Adicione um novo ClaimsProvider ao elemento ClaimsProviders.
Insira a ID do aplicativo que você registrou anteriormente, entre os elementos de abertura <Item Key="ClientId"> e fechamento </Item> .

Insira o Application ObjectID que você registrou anteriormente, entre os elementos de abertura <Item Key="ApplicationObjectId"> e fechamento </Item> .

<!-- 
<ClaimsProviders> -->
  <ClaimsProvider>
    <DisplayName>Azure Active Directory</DisplayName>
    <TechnicalProfiles>
      <TechnicalProfile Id="AAD-Common">
        <Metadata>
          <!--Insert b2c-extensions-app application ID here, for example: 00001111-aaaa-2222-bbbb-3333cccc4444-->  
          <Item Key="ClientId"></Item>
          <!--Insert b2c-extensions-app application ObjectId here, for example: aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb-->
          <Item Key="ApplicationObjectId"></Item>
        </Metadata>
      </TechnicalProfile>
    </TechnicalProfiles> 
  </ClaimsProvider>
<!-- 
</ClaimsProviders> -->

Carregar sua política personalizada

Entre no portal do Azure.
Se você tiver acesso a vários locatários, selecione o ícone Configurações no menu superior para alternar para seu locatário do Azure AD B2C no menu Diretórios + assinaturas.
Escolha Todos os serviços no canto superior esquerdo do portal do Azure e pesquise e selecione registros de aplicativo.
Selecione a Estrutura de Experiência de Identidade.
Selecione Carregar Política Personalizada e carregue os arquivos de política de TrustFrameworkExtensions.xml que você alterou.

Observação

Na primeira vez que o perfil técnico do Microsoft Entra ID persiste a declaração para o diretório, ele verifica se o atributo personalizado existe. Caso contrário, ele criará o atributo personalizado.

Criar um atributo personalizado por meio do portal do Azure

Os mesmos atributos de extensão são compartilhados entre políticas internas e personalizadas. Quando você adiciona atributos personalizados por meio da experiência do portal, esses atributos são registrados usando o b2c-extensions-app que existe em cada tenant B2C.

Você pode criar esses atributos usando a interface do usuário do portal antes ou depois de usá-los em suas políticas personalizadas. Ao criar um atributo loyaltyId no portal, você deve fazer referência a ele da seguinte maneira:

Nome	Usado em
`extension_loyaltyId`	Política personalizada
`extension_<b2c-extensions-app-guid>_loyaltyId`	Microsoft Graph API

Observação

Ao usar um atributo personalizado em políticas personalizadas, você deve adicionar o prefixo extension_ à ID do tipo de declaração para que o mapeamento de dados ocorra corretamente no diretório do Azure AD B2C.

O exemplo a seguir demonstra o uso de atributos personalizados em uma definição de declaração de política personalizada do Azure AD B2C.

<BuildingBlocks>
  <ClaimsSchema>
    <ClaimType Id="extension_loyaltyId">
      <DisplayName>Loyalty Identification</DisplayName>
      <DataType>string</DataType>
      <UserHelpText>Your loyalty number from your membership card</UserHelpText>
      <UserInputType>TextBox</UserInputType>
    </ClaimType>
  </ClaimsSchema>
</BuildingBlocks>

O exemplo a seguir demonstra o uso de um atributo personalizado na política personalizada do Azure AD B2C em um perfil técnico, entrada, saída e declarações persistentes.

<InputClaims>
  <InputClaim ClaimTypeReferenceId="extension_loyaltyId"  />
</InputClaims>
<PersistedClaims>
  <PersistedClaim ClaimTypeReferenceId="extension_loyaltyId" />
</PersistedClaims>
<OutputClaims>
  <OutputClaim ClaimTypeReferenceId="extension_loyaltyId" />
</OutputClaims>

Gerenciar atributos de extensão por meio do Microsoft Graph

Você pode usar o Microsoft Graph para criar e gerenciar os atributos personalizados e definir os valores para um usuário. Os atributos de extensão também são chamados de diretório ou extensões do Microsoft Entra.

Atributos personalizados (extensões de diretório) na API do Microsoft Graph são nomeados usando a convenção extension_{appId-without-hyphens}_{extensionProperty-name}, em que {appId-without-hyphens} é a versão simplificada da appId (chamada de ID do cliente no portal do Azure AD B2C) para o b2c-extensions-app, utilizando somente os caracteres de 0-9 e A-Z. Por exemplo, se a appID do aplicativo b2c-extensions-app for 11112222-bbbb-3333-cccc-4444dddd5555, e o nome do atributo for loyaltyId, o atributo personalizado será nomeado como extension_25883231668a43a780b25685c3f874bc_loyaltyId.

Saiba como gerenciar atributos de extensão em seu locatário do Azure AD B2C usando a API do Microsoft Graph.

Remover atributo de extensão

Ao contrário dos atributos internos, os atributos personalizados podem ser removidos. Os valores dos atributos de extensão também podem ser removidos.

Importante

Antes de remover o atributo personalizado, para cada conta no diretório, defina o valor do atributo de extensão como null. Dessa forma, você remove explicitamente os valores do atributo de extensão. Em seguida, continue removendo o próprio atributo de extensão. Atributos personalizados podem ser consultados usando a API do Microsoft Graph.

Use as seguintes etapas para remover um atributo personalizado de um fluxo de usuário em seu locatário:

Entre no portal do Azure pelo menos como Administrador de Atributo de Fluxo de Usuário de ID Externa do locatário do Azure AD B2C.
Verifique se você está usando o diretório que contenha seu locatário do Azure AD B2C:
1. Selecione o ícone Diretórios + assinaturas na barra de ferramentas do portal.
2. Nas configurações do Portal | Página Diretórios + assinaturas , localize o diretório do Azure AD B2C na lista de nomes do Diretório e selecione Alternar
Escolha Todos os serviços no canto superior esquerdo do portal do Azure, pesquise e selecione O Azure AD B2C.
Selecione atributos de usuário e, em seguida, selecione o atributo que você deseja excluir.
Selecione Excluir e, em seguida, selecione Sim para confirmar.

Use a API do Microsoft Graph para gerenciar os atributos personalizados.

Próximas etapas

Saiba como adicionar declarações e personalizar a entrada do usuário usando políticas personalizadas. Este exemplo usa uma declaração interna 'city'. Para usar um atributo personalizado, substitua "cidade" por seus próprios atributos personalizados.

Comentários

Esta página foi útil?

Last updated on 2025-05-02