---
title: "BooleanConfigFieldSchema"
url: "https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f/schemas/BooleanConfigFieldSchema"
---

> Full API specification: https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f.md

# BooleanConfigFieldSchema

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.2.0
servers:
  - url: https://us.api.konghq.com/v1
    description: US Region Base URL
  - url: https://eu.api.konghq.com/v1
    description: EU Region Base URL
  - url: https://au.api.konghq.com/v1
    description: AU Region Base URL
  - url: https://me.api.konghq.com/v1
    description: ME Region Base URL
  - url: https://in.api.konghq.com/v1
    description: IN Region Base URL
components:
  schemas:
    BaseConfigFieldSchema:
      type: object
      properties:
        display_name:
          type: string
          description: user-friendly name of the configuration field.
        description:
          type: string
          description: Optional brief description of the configuration field.
        required:
          type: boolean
          description: Denotes whether the config field is a required value.
          default: false
        mutable_condition:
          $ref: "#/components/schemas/MutableCondition"
    MutableCondition:
      description: >
        Defines the condition under which this configuration field is allowed to
        be modified.

        When specified, the platform will restrict updates to this field unless
        the integration

        meets the given condition.


        For example, setting `mutable_condition: unauthorized` means the field
        can only be 

        changed while the integration is in an unauthorized state.
      type: string
      enum:
        - unauthorized
    BooleanConfigFieldSchema:
      x-flatten-allOf: true
      allOf:
        - $ref: "#/components/schemas/BaseConfigFieldSchema"
        - title: BooleanConfigFieldSchema
          description: Defines a boolean value integration config field.
          type: object
          required:
            - type
          properties:
            type:
              type: string
              description: The field type of the config value.
              enum:
                - boolean
            default:
              type: boolean
              description: The default value for the config field.
```