Search
K
Konnect Service Catalog

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

OAuthAuthConfig

object
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