Verifique o cabeçalho HTTP

  • Artigo

APLICA-SE A: Todas as camadas de gerenciamento de API

Use a check-header política para impor que uma solicitação tenha um cabeçalho HTTP especificado. Opcionalmente, você pode verificar se o cabeçalho tem um valor específico ou um de um intervalo de valores permitidos. Se a verificação falhar, a política encerrará o processamento da solicitação e retornará o código de status HTTP e a mensagem de erro especificados pela política.

Nota

Defina os elementos da política e os elementos filho na ordem fornecida na declaração de política. Saiba mais sobre como definir ou editar políticas de Gerenciamento de API.

Declaração de política

<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>

Atributos

Atributo Description Necessário Predefinição
nome O nome do cabeçalho HTTP a ser verificado. São permitidas expressões de política. Sim N/A
failed-check-httpcode Código de status HTTP a ser retornado se o cabeçalho não existir ou tiver um valor inválido. São permitidas expressões de política. Sim N/A
falha-verificação-erro-mensagem Mensagem de erro para retornar no corpo da resposta HTTP se o cabeçalho não existir ou tiver um valor inválido. Esta mensagem deve ter todos os caracteres especiais escapados corretamente. São permitidas expressões de política. Sim N/A
ignorar-caso Booleano. Se definido como true, maiúsculas e minúsculas é ignorado quando o valor do cabeçalho é comparado com o conjunto de valores aceitáveis. São permitidas expressões de política. Sim N/A

Elementos

Elemento Description Necessário
valor Adicione um ou mais desses elementos para especificar valores de cabeçalho HTTP permitidos. Quando vários value elementos são especificados, a verificação é considerada um sucesso se qualquer um dos valores for uma correspondência. Não

Utilização

Exemplo

<check-header name="Authorization" failed-check-httpcode="401" failed-check-error-message="Not authorized" ignore-case="false">
    <value>f6dc69a089844cf6b2019bae6d36fac8</value>
</check-header>

Conteúdos relacionados

Para obter mais informações sobre como trabalhar com políticas, consulte: