Vérification d'en-tête HTTP
Utilisez la stratégie check-header pour imposer un en-tête HTTP donné à une demande. Vous pouvez également vérifier si l’en-tête a une valeur spécifique ou une valeur comprise dans une plage de valeurs autorisées. Si la vérification échoue, la stratégie met fin au traitement de la demande et renvoie le message d’erreur et le code d’état HTTP spécifiés par la stratégie.
Notes
Définissez les éléments enfants et de stratégie dans l’ordre fourni dans l’instruction de stratégie. En savoir plus sur comment définir ou modifier des stratégies du service Gestion des API.
Instruction de la stratégie
<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>
Attributs
| Attribut | Description | Obligatoire | Default |
|---|---|---|---|
| name | Nom de l’en-tête HTTP à vérifier. | Oui | N/A |
| failed-check-httpcode | Code d’état HTTP à renvoyer si l’en-tête n’existe pas ou a une valeur non valide. | Oui | N/A |
| failed-check-error-message | Message d’erreur à renvoyer dans le corps de la réponse HTTP si l’en-tête n’existe pas ou a une valeur non valide. Les éventuels caractères spéciaux de ce message doivent être correctement placés dans une séquence d’échappement. | Oui | N/A |
| ignore-case | Propriété booléenne. Si la valeur true est définie, la casse est ignorée quand la valeur de l’en-tête est comparée à l’ensemble des valeurs acceptables. |
Oui | N/A |
Éléments
| Élément | Description | Obligatoire |
|---|---|---|
| value | Ajoutez un ou plusieurs de ces éléments pour spécifier les valeurs d’en-tête HTTP autorisées. Quand plusieurs éléments value sont spécifiés, la vérification est considérée comme réussie si l’une des valeurs correspond. |
Non |
Usage
- Sections de la stratégie : inbound, outbound
- Étendues de la stratégie : global, product, API, operation
- Passerelles : dédiées, consommation, auto-hébergées
Exemple
<check-header name="Authorization" failed-check-httpcode="401" failed-check-error-message="Not authorized" ignore-case="false">
<value>f6dc69a089844cf6b2019bae6d36fac8</value>
</check-header>
Stratégies connexes
Étapes suivantes
Pour plus d’informations sur l’utilisation des stratégies, consultez :
- Tutoriel : Transformer et protéger votre API
- Référence de stratégie pour obtenir la liste complète des instructions et des paramètres de stratégie
- Expressions de stratégie
- Définir ou modifier des stratégies
- Réutilisation de configurations de stratégie
- Exemples de stratégie