Skip to main content

Parameters

See plugin common configurations for configuration options available to all plugins.

Consumers

The following are plugin attributes available for configurations on consumers.

  • 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: false


    If true, do not pass the authorization request header to upstream services.


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN Ltd. 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation