Konnect Service Catalog

CatalogIntegrationAuthorization

Defines the authorization strategy for an integration.

Any Of

OAuth

object

Defines the OAuth 2.0 authorization strategy used by an integration.
This schema provides all necessary information for the platform to initiate
and manage OAuth-based authorization flows on behalf of customers.

typestringrequired

Allowed values:oauth

overridable_configarray[string]

A list of field names from the config object (e.g., client_id, authorization_endpoint, etc)
that can be overridden on a per-customer basis. When a field is listed here, the catalog allows
customer-defined values to take precedence over the default configuration provided by the integration.
This supports flexible deployment models, including both SaaS-based and self-hosted OAuth authorization flows.

Allowed values:client_idclient_secretauthorization_endpointtoken_endpoint

configobjectrequired
Show Child Parameters
Example

MultiKeyAuth

object

Defines an authentication strategy based on one or more API keys passed via HTTP headers.
This strategy supports integrations that require custom headers for credential-based access,
allowing flexibility across providers with different authentication header requirements.

typestringrequired

Allowed values:multi_key_auth

configobjectrequired
Show Child Parameters
Example

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