Skip to main content
API7.ai Logo

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 bytes

    A shared symmetric key for A256GCM. A literal plaintext value must be exactly 32 bytes. If is_base64_encoded is true, the value must be base64url encoded and decode to 32 bytes. You can also use a $env:// or $secret:// gateway reference; the resolved value, rather than the reference string, must meet the same requirement. A reference can be accepted before resolution, but decryption fails if it resolves to a key of the wrong size.

  • is_base64_encoded

    boolean

    default: false

    Set to true if the secret is base64url encoded. The decoded secret must still be 32 bytes.

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, return a 403 error when the encrypted plugin token is missing. If false, continue when the token is not found.