Verificar o cabeçalho HTTP

  • Artigo

APLICA-SE A: todas as camadas do Gerenciamento de API

Use a política check-header para impor que uma solicitação tem um cabeçalho HTTP especificado. Você pode, opcionalmente, 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á a mensagem de erro e código de status HTTP especificada pela política.

Observação

Defina os elementos da política e os elementos filho na ordem fornecida na declaração da política. Saiba mais sobre como definir e editar as 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 Descrição Obrigatório Padrão
name O nome do cabeçalho HTTP a verificar. Expressões de política são permitidas. Sim N/D
failed-check-httpcode O código de status HTTP para retornar se o cabeçalho não existir ou tiver um valor inválido. Expressões de política são permitidas. Sim N/D
failed-check-error-message A mensagem de erro para retornar no corpo da resposta HTTP se o cabeçalho não existe ou tem um valor inválido. Esta mensagem deve conter quaisquer caracteres especiais adequadamente seguidos por caracteres de escape. Expressões de política são permitidas. Sim N/D
ignore-case Booliano. Se definido como true, maiúsculas e minúsculas são ignoradas quando o valor do cabeçalho é comparado com o conjunto de valores aceitáveis. Expressões de política são permitidas. Sim N/D

Elementos

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

Uso

Exemplo

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

Conteúdo relacionado

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