Konnect Service Catalog

EnumConfigFieldSchema

object

Defines an enum value integration config field.

display_namestring

user-friendly name of the configuration field.

descriptionstring

Optional brief description of the configuration field.

requiredboolean

Denotes whether the config field is a required value.

Default:false

mutable_conditionstring

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.

Allowed values:unauthorized

typestringrequired

The field type of config value.

Allowed values:enum

choicesarray[object]required

List of enumerated choices that can be selected as the config field value.

Show Child Parameters
defaultstring

The default value for the config field.
Must reference the value of an option listed in choices.

Example

BooleanConfigFieldSchema

object

Defines a boolean value integration config field.

display_namestring

user-friendly name of the configuration field.

descriptionstring

Optional brief description of the configuration field.

requiredboolean

Denotes whether the config field is a required value.

Default:false

mutable_conditionstring

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.

Allowed values:unauthorized

typestringrequired

The field type of the config value.

Allowed values:boolean

defaultboolean

The default value for the config field.

Example

MutableCondition

string

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.

Allowed values:unauthorized

CatalogIntegrationResourceTypes

object

Defines the resource types that the integration manages within the catalog.

This schema is a key-value object where:

  • Keys are globally unique, machine-readable identifiers for each resource type.
  • Values are objects describing metadata about the resource type.

This declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration.
By registering resource types, integrations communicate the kinds of entities they will ingest and maintain,
allowing the catalog to enforce consistency, validation, and visibility across all integrations.

Example

CatalogIntegrationResourceTypeIntegrationDataSchema

Any Of