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

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

# BooleanConfigFieldSchema

Defines a boolean value integration config field.

## 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:
    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:
      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"
        type:
          type: string
          description: The field type of the config value.
          enum:
            - boolean
        default:
          type: boolean
          description: The default value for the config field.
      title: BooleanConfigFieldSchema
      description: Defines a boolean value integration config field.
      required:
        - type
```