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

いくつかの Authlete API は、そのレスポンスに responseContent パラメーターを含みます。このパラメーターの値は、認可サーバーがクライアントに返却するレスポンスのコンテンツとして利用することが期待されています。

初期設定では、responseContent パラメーターの値にはエラーの詳細が含まれます。たとえば、parameters パラメーターの値に空の値（認可リクエストとしては正しくありません）を含むリクエストを /auth/authorization API に送信すると、同 API は次のようなレスポンスを生成します。

  • リクエスト

% curl -s -X POST $apiUrl/auth/authorization \
-u ...:... -H 'Content-type: application/json' \
-d '{"parameters":""}'

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

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

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

もしエラー詳細の出力を抑制したい場合には、Authlete サービスの「認可」にある以下の設定値を「省略する」に変更します。
項目
説明
既定値
エラー説明
error_description の省略に関する設定
省略しない
エラー URI
error_uri の省略に関する設定
省略しない


image.png 104.46 KB


これらの項目を両方とも「省略する」に設定すると、先のリクエストに対するレスポンスは以下のようになります。

[...]
"action": "BAD_REQUEST",
"responseContent": "{\"error\":\"invalid_request\"}",
[...]
How did we do with this article?