---
title: "SchemaRegistryConfluentConfigSensitiveDataAware"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19/schemas/SchemaRegistryConfluentConfigSensitiveDataAware"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19.md

# SchemaRegistryConfluentConfigSensitiveDataAware

The configuration of [Confluent Schema Registry](https://github.com/confluentinc/schema-registry)

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes Configuration for Event Gateways
  version: 1.0.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:
    SchemaRegistryAuthenticationSensitiveDataAwareScheme:
      description: The authentication configuration for the schema registry.
      discriminator:
        propertyName: type
        mapping:
          basic: "#/components/schemas/SchemaRegistryAuthenticationBasicSensitiveDataAwar\
            e"
      oneOf:
        - $ref: "#/components/schemas/SchemaRegistryAuthenticationBasicSensitiveDataAware"
    SchemaRegistryAuthenticationBasicSensitiveDataAware:
      type: object
      properties:
        type:
          type: string
          enum:
            - basic
          x-terraform-transform-const: true
        username:
          $ref: "#/components/schemas/GatewaySecretReferenceOrLiteral"
        password:
          $ref: "#/components/schemas/GatewaySecret"
      required:
        - type
        - username
    GatewaySecretReferenceOrLiteral:
      description: >
        A literal value or a reference to an existing secret as a template
        string expression.

        The value is stored and returned by the API as-is, not treated as
        sensitive information.
      type: string
      minLength: 1
      x-examples:
        reference:
          summary: Reference to a secret
          value: ${vault.env['MY_ENV_VAR']}
        literal:
          summary: Literal value
          value: my-literal-value
      x-expression:
        type: string
        fields:
          - vault
    GatewaySecret:
      description: >
        A sensitive value containing the secret or a reference to a secret as a
        template string expression.

        If the value is provided as plain text, it is encrypted at rest and
        omitted from API responses.

        If provided as an expression, the expression itself is stored and
        returned by the API.
      type: string
      example: ${vault.env['MY_ENV_VAR']}
      minLength: 1
      x-expression:
        type: string
        fields:
          - vault
      x-sensitive: true
    SchemaRegistryConfluentConfigSensitiveDataAware:
      description: >
        The configuration of [Confluent Schema
        Registry](https://github.com/confluentinc/schema-registry)
      type: object
      properties:
        schema_type:
          description: The format of the message.
          type: string
          enum:
            - avro
            - json
        endpoint:
          description: The endpoint of the Confluent schema registry.
          type: string
          format: uri
          minLength: 1
        timeout_seconds:
          description: >
            Total time in seconds from establishing connection to receive a
            response from schema registry.
          type: integer
          default: 10
          minimum: 1
        authentication:
          $ref: "#/components/schemas/SchemaRegistryAuthenticationSensitiveDataAwareSchem\
            e"
      required:
        - schema_type
        - endpoint
```
