Search
K
Konnect Service Catalog

CreateGitHubAppInstallationCredential

object

Payload used to create an GitHub App Installation credential for an integration instance.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:github_app_installation

configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

CreateMultiKeyAuthCredential

object

Payload used to create an Multi Key credential for an integration instance.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:multi_key_auth

configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

CreateAWSRoleDelegationAuthCredential

object

Payload used to create an AWS Role Delegation credential for an integration instance.

* Additional properties are NOT allowed.
typestringrequired

Allowed values:aws_role_delegation

configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

OAuthCredential

object

Represents a credential scoped to an integration instance that supports the OAuth authorization strategy.

idstring(uuid)required

Example:4f535923-ec24-456c-b4e5-e67f65c8c208

integration_instanceobjectrequired

Short-hand descriptor of an integration instance.

Show Child Parameters
missing_permissionsarray[object]required

List of detected missing permissions required to enable the full functionality of the given integration instance.

Show Child Parameters
taintedbooleanrequired

Indicates that the credential is no longer valid and must be replaced with a new valid credential.

expires_atstring(date-time)required

Timestamp denoting when the when the credential will expire in RFC-3339 format with a “T” character separating date from time within the field value.
When expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.

A null value indicates no known expiration time.

Example:2025-04-01T07:20:50Z

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

typestringrequired

Allowed values:oauth

Example

GitHubAppInstallationCredential

object

Represents a credential scoped to an integration instance that supports the GitHub App Installation authorization strategy.

idstring(uuid)required

Example:4f535923-ec24-456c-b4e5-e67f65c8c208

integration_instanceobjectrequired

Short-hand descriptor of an integration instance.

Show Child Parameters
missing_permissionsarray[object]required

List of detected missing permissions required to enable the full functionality of the given integration instance.

Show Child Parameters
taintedbooleanrequired

Indicates that the credential is no longer valid and must be replaced with a new valid credential.

expires_atstring(date-time)required

Timestamp denoting when the when the credential will expire in RFC-3339 format with a “T” character separating date from time within the field value.
When expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.

A null value indicates no known expiration time.

Example:2025-04-01T07:20:50Z

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

typestringrequired

Allowed values:github_app_installation

configobjectrequired
Show Child Parameters
Example