Key Authentication

Adds API key Authentication to the route. This requires at least one valid consumer in the system.

Configuration

Value	Description
add_username_header	Adds a Direktiv-Consumer-User header for authenticated user.
add_tags_header	Adds a "Direktiv-Consumer-Tags header for authenticated user.
add_groups_header	Adds a Direktiv-Consumer-Groups header for authenticated user.
key_name	Name of the header for this API key.

Example

Key Authentication

x-direktiv-api: endpoint/v2
x-direktiv-config:
  allow_anonymous: false
  path: /keyauth
  plugins:
    target:
      type: target-flow-var
      configuration:
        flow: /envs-wf/wf.yaml
        variable: hello
    auth:
      - type: key-auth
        configuration:
          add_username_header: false
          add_tags_header: false
          add_groups_header: false
          key_name: myapikey
get:
  summary: Key auth endpoint
  responses:
    "200":
      description: Success