Clearing a claim from the claims bag in Azure AD B2C

Ervins Strauhmanis, CC BY 2.0, via Wikimedia Commons

You sometimes need to clear a claim in the claims bag while using custom policies.

This may be because you have set a temporary claims flag in a workflow, and you no longer want it.

You want to ensure that “ClaimsExist” will return “False”.

This is documented here.

<TechnicalProfile Id="AAD-DeleteClaimsUsingObjectId">
  <Metadata>
    <Item Key="Operation">DeleteClaims</Item>
  </Metadata>
  <InputClaims>
    <InputClaim ClaimTypeReferenceId="objectId" Required="true" />
  </InputClaims>
  <PersistedClaims>
    <PersistedClaim ClaimTypeReferenceId="objectId" />
    <PersistedClaim ClaimTypeReferenceId="Verified.strongAuthenticationPhoneNumber" PartnerClaimType="strongAuthenticationPhoneNumber" />
  </PersistedClaims>
  <OutputClaims />
  <IncludeTechnicalProfile ReferenceId="AAD-Common" />
</TechnicalProfile>

Other examples in the samples are:

<TechnicalProfile Id="AAD-UserRemoveMustResetPasswordUsingObjectId">
 <Metadata>
  <Item Key="Operation">DeleteClaims</Item>
 </Metadata>
 <InputClaims>
  <InputClaim ClaimTypeReferenceId="objectId" Required="true"/>
 </InputClaims>
 <PersistedClaims>
  <PersistedClaim ClaimTypeReferenceId="objectId"/>
  <PersistedClaim ClaimTypeReferenceId="extension_mustResetPassword"/>
 </PersistedClaims>
 <IncludeTechnicalProfile ReferenceId="AAD-Common"/>
</TechnicalProfile>

and:

<TechnicalProfile Id="AAD-DeleteLegacyTOTPClaim">
 <Metadata>
  <Item Key="Operation">DeleteClaims</Item>
 </Metadata>
 <InputClaims>
  <InputClaim ClaimTypeReferenceId="objectId" Required="true"/>
 </InputClaims>
 <PersistedClaims>
  <PersistedClaim ClaimTypeReferenceId="objectId"/>
  <PersistedClaim ClaimTypeReferenceId="extension_StrongAuthenticationAppSecretKey"/>
 </PersistedClaims>
 <IncludeTechnicalProfile ReferenceId="AAD-Common"/>
</TechnicalProfile>

All good!