Parameters
See plugin common configurations for configuration options available to all plugins.
Credentials
The following are plugin attributes available for configurations on credentials.
username
string
required
Unique basic auth username for a consumer.
password
string
required
Basic auth password for the consumer.
The password is encrypted with AES before saving to etcd. You can also keep it in a secret manager, such as HashiCorp Vault's KV secrets engine. See secrets for more details.
Routes or Services
The following are plugin attributes available for configurations on routes or services.
hide_credentials
boolean
default:
falseIf true, do not pass the authorization request header to upstream services.
anonymous_consumer
string
Anonymous consumer name (Enterprise feature). If configured, allow anonymous users to bypass the authentication. See Rate Limit with Anonymous Consumer for more details.