Search
K
Konnect Service Catalog

AWSRoleDelegationAuthCredential

object

Represents a credential scoped to an integration instance that supports the AWS Role Delegation 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:aws_role_delegation

configobjectrequired
Show Child Parameters
Example

MissingPermission

object
scopesarray[string]required

Example:incident:read

messagestringrequired

Describes the degraded experience of the integration instance due to the missing permission.
May also include a message on how to resolve the missing permission.

Example

UpsertIntegrationInstanceAuthConfig

One Of
typestringrequired

Allowed values:oauth

client_idstringrequired

The OAuth client identifier.

Example:d745213a-b7e8-4998-abe3-41f164001970

client_secretstringrequired

The OAuth client secret.

Example:s3cr3t4p1cl13ntt0k3n1234567890abcdef

authorization_endpointstring(uri)required

The URL where users are redirected to authorize access.

Example:https://identity.service.com/oauth/authorize

token_endpointstring(uri)required

The URL used to retrieve access tokens.

Example:https://identity.service.com/oauth/token

Example

IntegrationInstanceAuthConfig

One Of
typestringrequired

Allowed values:oauth

client_idstringrequired

The OAuth client identifier.

Example:d745213a-b7e8-4998-abe3-41f164001970

authorization_endpointstring(uri)required

The URL where users are redirected to authorize access.

Example:https://identity.service.com/oauth/authorize

token_endpointstring(uri)required

The URL used to retrieve access tokens.

Example:https://identity.service.com/oauth/token

Example

OAuth Config

object
* Additional properties are NOT allowed.
typestringrequired

Allowed values:oauth

client_idstringrequired

The OAuth client identifier.

Example:d745213a-b7e8-4998-abe3-41f164001970

client_secretstringrequired

The OAuth client secret.

Example:s3cr3t4p1cl13ntt0k3n1234567890abcdef

authorization_endpointstring(uri)required

The URL where users are redirected to authorize access.

Example:https://identity.service.com/oauth/authorize

token_endpointstring(uri)required

The URL used to retrieve access tokens.

Example:https://identity.service.com/oauth/token

Example