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.

  • 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 keep secrets in a secret manager, such as HashiCorp Vault's KV secrets engine. See secrets for more details.

  • is_base64_encoded

    boolean


    default: false


    Set 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: Authorization


    The header to get the token from.

  • forward_header

    string


    required


    default: Authorization


    Name of the header that passes the plaintext to the upstream.

  • strict

    boolean


    default: true


    If 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.


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 PTE. LTD 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation