Compartilhar via

Definir um perfil técnico do Microsoft Entra ID SSPR em uma política personalizada do Azure AD B2C

Observação

No Azure Active Directory B2C, as políticas personalizadas são projetadas principalmente para tratar de cenários complexos. Para a maioria dos cenários, recomendamos que você use fluxos de usuários predefinidos. Se você ainda não fez isso, saiba mais sobre o pacote de início de política personalizado em Introdução às políticas personalizadas no 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.

O Azure AD B2C (Azure Active Directory B2C) oferece suporte para verificar um endereço de email para redefinição de senha de autoatendimento (SSPR). Use o perfil técnico do Microsoft Entra ID SSPR para gerar e enviar um código para um endereço de email e, em seguida, verificar o código. O perfil técnico do Microsoft Entra ID SSPR também pode retornar uma mensagem de erro. O perfil técnico de validação valida os dados fornecidos pelo usuário antes que o percurso do usuário continue. Com o perfil técnico de validação, uma mensagem de erro é exibida em uma página autodeclarada.

Este perfil técnico:

  • Não fornece uma interface para interagir com o usuário. Em vez disso, a interface do usuário é chamada de um perfil técnico autodeclarado ou de um controle de exibição como um perfil técnico de validação.
  • Usa o serviço SSPR do Microsoft Entra para gerar e enviar um código para um endereço de email e, em seguida, verifica o código.
  • Valida um endereço de email por meio de um código de verificação.

Protocolo

O atributo Name do elemento Protocol precisa ser definido como Proprietary. O atributo manipulador deve conter o nome totalmente qualificado do assembly do manipulador de protocolo usado pelo Azure AD B2C:

Web.TPEngine.Providers.AadSsprProtocolProvider, Web.TPEngine, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null

O exemplo a seguir mostra um perfil técnico do Microsoft Entra ID SSPR:

<TechnicalProfile Id="AadSspr-SendCode">
  <DisplayName>Send Code</DisplayName>
  <Protocol Name="Proprietary" Handler="Web.TPEngine.Providers.AadSsprProtocolProvider, Web.TPEngine, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
    ...

Enviar email

O primeiro modo desse perfil técnico é gerar um código e enviá-lo. As seguintes opções podem ser configuradas para esse modo.

Declarações de entrada

O elemento InputClaims contém uma lista de declarações a serem enviadas ao Microsoft Entra SSPR. Você também pode mapear o nome de sua declaração para o nome definido no perfil técnico de SSPR.

ReivindicaçãoReferênciaId Obrigatório Descrição
endereço de email Sim O identificador do usuário que possui o endereço de email. A PartnerClaimType propriedade da declaração de entrada deve ser definida como emailAddress.

O elemento InputClaimsTransformations pode conter uma coleção de elementos InputClaimsTransformation que são usados para modificar as declarações de entrada ou gerar novas antes de enviar para o serviço SSPR do Microsoft Entra.

Declarações de saída

O provedor de protocolo SSPR do Microsoft Entra não retorna nenhum OutputClaims, portanto, não há necessidade de especificar declarações de saída. No entanto, você pode incluir declarações que não são retornadas pelo provedor de protocolo SSPR do Microsoft Entra, desde que você defina o DefaultValue atributo.

O elemento OutputClaimsTransformations pode conter uma coleção de elementos OutputClaimsTransformation usados para modificar as declarações de saída ou gerar novas declarações.

Metadados

Atributo Obrigatório Descrição
Operação Sim Deve ser SendCode.

Elementos da interface do usuário

Os metadados a seguir podem ser usados para configurar as mensagens de erro exibidas após a falha de envio do SMS. Os metadados devem ser configurados no perfil técnico autodeclarado . A mensagem de erro pode ser localizada.

Atributo Obrigatório Descrição
UserMessageIfInternalError Não Mensagem de erro do usuário se o servidor tiver encontrado um erro interno.
UserMessageIfThrottled Não Mensagem de erro do usuário se uma solicitação tiver sido limitada.

Exemplo: enviar um email

O exemplo a seguir mostra um perfil técnico do Microsoft Entra ID SSPR usado para enviar um código por email.

<TechnicalProfile Id="AadSspr-SendCode">
  <DisplayName>Send Code</DisplayName>
  <Protocol Name="Proprietary" Handler="Web.TPEngine.Providers.AadSsprProtocolProvider, Web.TPEngine, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
  <Metadata>
    <Item Key="Operation">SendCode</Item>
  </Metadata>
  <InputClaims>
    <InputClaim ClaimTypeReferenceId="email" PartnerClaimType="emailAddress"/>
  </InputClaims>
</TechnicalProfile>

Verificar o código

O segundo modo desse perfil técnico é verificar um código. As seguintes opções podem ser configuradas para esse modo.

Declarações de entrada

O elemento InputClaims contém uma lista de declarações a serem enviadas ao Microsoft Entra SSPR. Você também pode mapear o nome de sua declaração para o nome definido no perfil técnico de SSPR.

ReivindicaçãoReferênciaId Obrigatório Descrição
endereço de email Sim Mesmo endereço de email usado anteriormente para enviar um código. Ele também é usado para localizar uma sessão de verificação de email. A PartnerClaimType propriedade da declaração de entrada deve ser definida como emailAddress.
Código de verificação Sim O código de verificação fornecido pelo usuário a ser verificado. A PartnerClaimType propriedade da declaração de entrada deve ser definida como verificationCode.

O elemento InputClaimsTransformations pode conter uma coleção de elementos InputClaimsTransformation que são usados para modificar as declarações de entrada ou gerar novas antes de chamar o serviço SSPR do Microsoft Entra.

Declarações de saída

O provedor de protocolo SSPR do Microsoft Entra não retorna nenhum OutputClaims, portanto, não há necessidade de especificar declarações de saída. No entanto, você pode incluir declarações que não são retornadas pelo provedor de protocolo SSPR do Microsoft Entra, desde que você defina o DefaultValue atributo.

O elemento OutputClaimsTransformations pode conter uma coleção de elementos OutputClaimsTransformation usados para modificar as declarações de saída ou gerar novas declarações.

Metadados

Atributo Obrigatório Descrição
Operação Sim Deve ser VerifyCode

Elementos da interface do usuário

Os metadados a seguir podem ser usados para configurar as mensagens de erro exibidas em caso de falha na verificação do código. Os metadados devem ser configurados no perfil técnico autodeclarado . A mensagem de erro pode ser localizada.

Atributo Obrigatório Descrição
UserMessageIfChallengeExpired A mensagem a ser exibida ao usuário se a sessão de verificação de código tiver expirado. O código expirou ou o código nunca foi gerado para um determinado identificador.
UserMessageIfInternalError Mensagem de erro do usuário se o servidor tiver encontrado um erro interno.
UserMessageIfThrottled Mensagem de erro do usuário se uma solicitação tiver sido limitada.
UserMessageIfVerificationFailedNoRetry A mensagem a ser exibida ao usuário se ele tiver fornecido um código inválido e o usuário não tiver permissão para fornecer o código correto.
UserMessageIfVerificationFailedRetryAllowed A mensagem a ser exibida ao usuário se ele tiver fornecido um código inválido e o usuário tiver permissão para fornecer o código correto.

Exemplo: verificar um código

O exemplo a seguir mostra um perfil técnico do Microsoft Entra ID SSPR usado para verificar o código.

<TechnicalProfile Id="AadSspr-VerifyCode">
  <DisplayName>Verify Code</DisplayName>
  <Protocol Name="Proprietary" Handler="Web.TPEngine.Providers.AadSsprProtocolProvider, Web.TPEngine, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
  <Metadata>
    <Item Key="Operation">VerifyCode</Item>
  </Metadata>
  <InputClaims>
    <InputClaim ClaimTypeReferenceId="verificationCode" PartnerClaimType="verificationCode" />
    <InputClaim ClaimTypeReferenceId="email" PartnerClaimType="emailAddress"/>
  </InputClaims>
</TechnicalProfile>
  • Last updated on