Search
K
Konnect Service Catalog

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

InitializeCatalogResource

object
* Additional properties are NOT allowed.
typestringrequired

The resource type. Available resource types are compiled from the integrations installed within the catalog.

>= 1 characters<= 120 characters

Example:gateway_svc

configobjectrequired

JSON object representing the properties used to identify the resource in the third-party system.
The schema depends on the resource type and is dynamically registered at runtime.

Example:{"control_plane_id":"ccadfb0a-56cd-4f74-955d-aec1d87157c8","gateway_service_id":"94896d05-0c4d-45eb-aae3-de754885dd58"}

* Additional properties are allowed.
Example

DeleteCatalogResources

object
* Additional properties are NOT allowed.
dataarray[object]required

>= 1 items<= 100 items

* Additional properties are NOT allowed.
Show Child Parameters
Example

UpdateCatalogResource

object
* Additional properties are NOT allowed.
archivedboolean

Whether or not to archive the resource.
When a resource is archived, all catalog service mappings will be removed.

Example