---
title: "MultiKeyAuth"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/MultiKeyAuth"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# MultiKeyAuth

Defines an authentication strategy based on one or more API keys passed via HTTP headers. This strategy supports integrations that require custom headers for credential-based access, allowing flexibility across providers with different authentication header requirements.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    MultiKeyAuth:
      type: object
      description: >
        Defines an authentication strategy based on one or more API keys passed
        via HTTP headers.

        This strategy supports integrations that require custom headers for
        credential-based access,

        allowing flexibility across providers with different authentication
        header requirements.
      required:
        - type
        - config
      properties:
        type:
          type: string
          enum:
            - multi_key_auth
          x-terraform-transform-const: true
        config:
          type: object
          required:
            - headers
          properties:
            headers:
              type: array
              minItems: 1
              description: >
                A list of header definitions used to transmit API credentials to
                the integration's external API.

                Each header represents a unique key required by the provider.
              items:
                type: object
                title: KeyAuthHeader
                required:
                  - name
                  - display_name
                  - description
                properties:
                  name:
                    description: The exact name of the HTTP request header where the credential
                      should be inserted.
                    type: string
                    example: X-API-Key
                  display_name:
                    description: An optional user-friendly label for the key, used in UI forms to
                      guide users.
                    type: string
                    example: API Key
                    nullable: true
                  description:
                    description: An optional brief explanation of the purpose or usage of the key.
                    type: string
                    nullable: true
```