HTTP ヘッダーを確認する
適用対象: すべての API Management レベル
check-header ポリシーを使用して、HTTP ヘッダーの指定がもれなく要求に含まれるようにします。 必要に応じて、ヘッダーに特定の値が指定されているかどうか、または許可されている範囲内の値かどうかを確認できます。 チェックに失敗した場合、このポリシーに従って要求の処理は終了し、ポリシーで指定した HTTP 状態コードとエラー メッセージが返されます。
Note
ポリシーの要素と子要素を、ポリシー ステートメントで指定された順序で設定します。 API Management ポリシーを設定または編集する方法について説明します。
ポリシー ステートメント
<check-header name="header name" failed-check-httpcode="code" failed-check-error-message="message" ignore-case="true | false">
<value>Value1</value>
<value>Value2</value>
</check-header>
属性
| 属性 | 説明 | 必要 | Default |
|---|---|---|---|
| name | チェックする HTTP ヘッダーの名前。 ポリシー式を使用できます。 | はい | 該当なし |
| failed-check-httpcode | ヘッダーが存在しないかヘッダーが無効な値である場合に返される HTTP 状態コード。 ポリシー式を使用できます。 | はい | 該当なし |
| failed-check-error-message | ヘッダーが存在しないかヘッダーが無効な値である場合に HTTP 応答本文で返されるエラー メッセージ。 このメッセージ内では、特殊文字を適切にエスケープする必要があります。 ポリシー式を使用できます。 | はい | 該当なし |
| ignore-case | Boolean です。 true に設定した場合、ヘッダー値と許容される値セットとの比較時に大文字と小文字は区別されません。 ポリシー式を使用できます。 |
はい | 該当なし |
要素
| 要素 | 説明 | 必須 |
|---|---|---|
| value | これらの要素を 1 つ以上追加して、許可される HTTP ヘッダー値を指定します。 複数の value 要素を指定した場合、いずれかの値に一致すればチェックは成功とみなされます。 |
いいえ |
使用法
- ポリシー セクション: inbound
- ポリシー スコープ: グローバル、製品、API、操作
- ゲートウェイ: クラシック、v2、従量課金、セルフホステッド、ワークスペース
例
<check-header name="Authorization" failed-check-httpcode="401" failed-check-error-message="Not authorized" ignore-case="false">
<value>f6dc69a089844cf6b2019bae6d36fac8</value>
</check-header>
関連ポリシー
関連するコンテンツ
ポリシーに対する処理の詳細については、次のトピックを参照してください。