Parameters
See plugin common configurations for configuration options available to all plugins.
Consumers
The following are plugin attributes available for configurations on consumers.
key
string
required
A unique key that identifies the credential for a consumer.
secret
string
required
vaild vaule:
32 characters
The encryption key. You can also store it in an environment variable and reference it using the
env://prefix, or in a secret manager such as HashiCorp Vault's KV secrets engine, and reference it using thesecret://prefix. For more information, see secrets.is_base64_encoded
boolean
default:
falseSet to true if the secret is base64 encoded.
Routes or Services
The following are plugin attributes available for configurations on routes or services.
header
string
required
default:
AuthorizationThe header to get the token from.
forward_header
string
required
default:
AuthorizationName of the header that passes the plaintext to the upstream.
strict
boolean
default:
trueIf true, throw a 403 error if JWE token is missing from the request. If false, do not throw an error when JWE token is not found.