---
title: "BooleanConfigFieldSchema"
url: "https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-dev-1/versions/d755cd20-1635-4c78-a12c-5f42a75fa20d/schemas/BooleanConfigFieldSchema"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-dev-1/versions/d755cd20-1635-4c78-a12c-5f42a75fa20d.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:
      description: Defines a boolean value integration config field.
      type: object
      properties:
        display_name:
          description: user-friendly name of the configuration field.
          type: string
        description:
          description: Optional brief description of the configuration field.
          type: string
        required:
          description: Denotes whether the config field is a required value.
          type: boolean
          default: false
        mutable_condition:
          $ref: "#/components/schemas/MutableCondition"
        type:
          description: The field type of the config value.
          type: string
          enum:
            - boolean
        default:
          description: The default value for the config field.
          type: boolean
      required:
        - type
      title: BooleanConfigFieldSchema
```
