O componente de autenticação por chave de API valida requisições recebidas ao extrair uma chave de API da requisição HTTP e verificá-la em relação a uma lista de credenciais confiáveis. Configure o componente para ler a chave de um parâmetro de URL, cabeçalho de requisição ou cookie.
Categoria do recurso: Autenticação e autorização
Descrição dos campos
ComponentConfig
|
Parâmetro |
Tipo |
Obrigatório |
Padrão |
Descrição |
|
Config |
ApiKeyConfig |
Sim |
- |
Configuração de autenticação por chave de API. |
ApiKeyConfig
|
Parâmetro |
Tipo |
Obrigatório |
Padrão |
Descrição |
|
ApiKeySources |
ApiKeySourcesConfig |
Sim |
- |
Local de extração da chave de API. Há suporte para apenas uma source de extração. |
|
ApiKeyCredentials |
ApiKeyCredential[] |
Sim |
- |
Lista de credenciais de chave de API confiáveis para validação. |
ApiKeySourcesConfig
Especifique exatamente um dos campos a seguir. O componente lê a chave de API da source configurada.
|
Parâmetro |
Tipo |
Obrigatório |
Padrão |
Descrição |
|
Headers |
String[] |
Não |
- |
Cabeçalhos de requisição para extração da chave de API. |
|
Params |
String[] |
Não |
- |
Parâmetros de URL para extração da chave de API. |
|
Cookies |
String[] |
Não |
- |
Cookies para extração da chave de API. |
ApiKeyCredential
|
Parâmetro |
Tipo |
Obrigatório |
Padrão |
Descrição |
|
Provider |
ApiKeyCredentialProvider |
Sim |
System |
Tipo de credencial. Valores válidos: |
|
Credential |
String |
Condicional |
- |
String da chave de API. Obrigatório quando |
ApiKeyCredentialProvider
|
Valor |
Descrição |
|
System |
Credencial gerada pelo sistema. |
|
Custom |
Credencial enviada pelo usuário. |
Códigos de erro
|
Código de status HTTP |
Mensagem de erro |
Causa |
|
401 |
Falha na autenticação do cliente. |
Falha na verificação da chave de API. A chave de API é inválida ou está ausente. |