Konnect Service Catalog

GitHubAppInstallationAuth

object

Defines the GitHub App authorization strategy used by the GitHub integration.
This strategy enables secure access to GitHub APIs using app installation tokens.
It supports both API-based interactions and real-time event delivery via GitHub webhooks.
Unlike standard OAuth flows, this strategy leverages GitHub’s custom app installation flow
and token lifecycle, making it ideal for deep, organization-level GitHub integration.

typestringrequired

Allowed values:github_app_installation

configobjectrequired
Show Child Parameters
Example

CatalogIntegrationConfigSchema

Defines the configuration schema for the integration.

Example

StringConfigFieldSchema

object

Defines a string 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:string

defaultstring

The default value for the config field.

Example

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