Azure Active Directory B2C カスタムポリシーで OAuth2 カスタムエラーの技術プロファイルを定義する

[アーティクル]
01/11/2024

この記事では、Azure Active Directory B2C (Azure AD B2C) で OAuth2 カスタムエラーを処理する方法について説明します。ポリシーで何らかのロジックに問題がある場合は、この技術プロファイルを使用します。技術プロファイルによって、OAuth2 または OpenId Connect 証明書利用者アプリケーションにエラーが返されます。 OAuth2カスタムエラー技術プロファイルのライブデモをご確認ください。

カスタム OAuth2 エラーメッセージを処理するには:

Auth2 エラーの技術プロファイルを定義します。
エラーコードとエラーメッセージのクレームを設定します。
ユーザー体験から、OAuth2 エラーの技術プロファイルを呼び出します。

OAuth2 エラー

エラーでは、次のデータが返されます。

erroraccess_denied
error_description - という規則を使用したエラーメッセージ。
Correlation ID - Azure AD B2C 関連付け ID。
Timestamp - エラーのタイムスタンプ。

次の例では、 https://jwt.ms アプリに返されるカスタムエラーメッセージを示しています。

https://jwt.ms/#error=access_denied&error_description=AAD_Custom_1234%3a+My+custom+error+message%0d%0aCorrelation+ID%3a+233bf9bd-747a-4800-9062-6236f3f69a47%0d%0aTimestamp%3a+2021-03-25+14%3a01%3a23Z%0d%0a

Protocol

Protocol 要素の Name 属性は OAuth2 に設定する必要があります。 OutputTokenFormat 要素をに設定します。

次の例は、ReturnOAuth2Error 用の技術プロファイルを示しています。

<!--
 <ClaimsProviders> -->
  <ClaimsProvider>
    <DisplayName>Token Issuer</DisplayName>
    <TechnicalProfiles>
      <TechnicalProfile Id="ReturnOAuth2Error">
        <DisplayName>Return OAuth2 error</DisplayName>
        <Protocol Name="OAuth2" />
        <OutputTokenFormat>OAuth2Error</OutputTokenFormat>
        <CryptographicKeys>
          <Key Id="issuer_secret" StorageReferenceId="B2C_1A_TokenSigningKeyContainer" />
        </CryptographicKeys>
        <InputClaims>
          <InputClaim ClaimTypeReferenceId="errorCode" />
          <InputClaim ClaimTypeReferenceId="errorMessage" />
        </InputClaims>
      </TechnicalProfile>
    </TechnicalProfiles>
  </ClaimsProvider>
<!--
</ClaimsProviders> -->

入力クレーム

Inputclaims 要素には、OAuth2 エラーを返すために必要なクレームの一覧が含まれています。

ClaimReferenceId	必須	説明
errorCode	はい	エラーコード。
errorMessage	はい	エラーメッセージ。

暗号化キー

CryptographicKeys 要素には、次のキーが含まれています。

属性	必須	説明
issuer_secret	はい	X509 証明書 (RSA キーセット)。「`B2C_1A_TokenSigningKeyContainer`」で構成した `B2C_1A_TokenSigningKeyContainer` キーを使用します。

技術プロファイルを呼び出す

ユーザー体験、またはサブ体験 ( transferのタイプ）からOAuth2エラー技術プロファイルを呼び出すことができます。オーケストレーションステップの種類をに設定し、OAuth2 エラーの技術プロファイルへの参照を設定します。

ユーザー体験またはサブ体験に既に別の SendClaims オーケストレーションステップがある場合は、DefaultCpimIssuerTechnicalProfileReferenceId 属性をトークン発行者の技術プロファイルに設定します。

次に例を示します。

ユーザー体験 SignUpOrSignIn-Custom は、DefaultCpimIssuerTechnicalProfileReferenceId をトークン発行者の技術プロファイルに設定しますJwtIssuer。
8 番目のオーケストレーションステップでは、errorCode が存在するかどうかを確認しています。「はい」の場合は、ReturnOAuth2Error 技術プロファイルを呼び出してエラーを返します。
errorCode が存在しない場合は、9 番目のオーケストレーションステップによってトークンが発行されます。

<UserJourney Id="SignUpOrSignIn-Custom" DefaultCpimIssuerTechnicalProfileReferenceId="JwtIssuer">
  <OrchestrationSteps>
    ...
    <OrchestrationStep Order="8" Type="SendClaims" CpimIssuerTechnicalProfileReferenceId="ReturnOAuth2Error">
      <Preconditions>
        <Precondition Type="ClaimsExist" ExecuteActionsIf="false">
          <Value>errorCode</Value>
          <Action>SkipThisOrchestrationStep</Action>
        </Precondition>
      </Preconditions>
    </OrchestrationStep>

    <OrchestrationStep Order="9" Type="SendClaims" CpimIssuerTechnicalProfileReferenceId="JwtIssuer" />

  </OrchestrationSteps>
  <ClientDefinition ReferenceId="DefaultWeb" />
</UserJourney>

次のステップ

UserJourneys の詳細

Azure Active Directory B2C カスタム ポリシーで OAuth2 カスタム エラーの技術プロファイルを定義する