responseContent におけるエラー詳細出力の抑制 - Authlete Documentation

Authlete 2.x のドキュメントは 2.x 版をご覧ください。

はじめに

いくつかの Authlete API は、そのレスポンスに responseContent パラメーターを含みます。このパラメーターの値は、認可サーバーがクライアントに返却するレスポンスのコンテンツとして利用することが期待されています。初期設定では、responseContent パラメーターの値にはエラーの詳細が含まれます。たとえば、parameters パラメーターに空の値（認可リクエストとしては正しくありません）を含むリクエストを /auth/authorization API に送信すると、同 API は次のようなレスポンスを生成します。

リクエスト

curl -s -X POST https://us.authlete.com/api/{Service ID}/auth/authorization \
  -H 'Authorization: Bearer V5a40R6********C*******95q4HC0Z-T0YKD9-nR6F' \
  -H 'Content-Type: application/json' \
  -d '{"parameters":""}'

レスポンス（読みやすさのため改行しています）

[...]
"action": "BAD_REQUEST",
"responseContent":
  "{\"error\":\"invalid_request\",
    \"error_description\":
      \"[A166301] The request does not contain
       any request parameters.\",
    \"error_uri\":
      \"https://docs.authlete.com/#A166301\"}",
[...]

responseContent に含まれる error_description（エラー説明）および error_uri（エラー URI）は、Authlete 独自のエラー詳細です。これらはシステム構築時やテスト環境において、クライアントアプリケーションやユーザーエージェントが問題を解決する際に有用ですが、本番環境では不要かもしれません。本番環境では、両方を抑制することを推奨します。

Authlete の設定

エラー詳細の出力を抑制するには、対象のサービスで次のように設定します。

Authlete 管理コンソールにログインします。
組織名をクリックし、対象のサービスを選択します。
「サービス設定 > エンドポイント > 基本設定 > 一般」へ移動します。
「エラー詳細」セクションまでスクロールします。
「エラー詳細を含める」と「エラーURIを含める」をオフにします。

エラー詳細の設定

管理 API で設定する場合は、サービスの errorDescriptionOmitted と errorUriOmitted を true にします。コンソールのトグルは「含める」、API のプロパティは「省略する」を表すため、両者の真偽が反転している点に注意してください。両方をオフにすると、先のリクエストに対するレスポンスは次のようになります。

[...]
"action": "BAD_REQUEST",
"responseContent": "{\"error\":\"invalid_request\"}",
[...]