Get Application by Portal

Returns the configuration of a single application in this portal. If an application is linked to a DCR Provider, the dcr_provider.id and reference_id can be used to correlate it. An application manages a set of credentials and registrations for specific API product versions.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

applicationIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

application/json

Details about an application in a portal.

GetApplicationResponse

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

namestringrequired

The unique (per developer) name of the application.

descriptionstring | nullrequired

A description of the application.

labelsobject | nullrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

reference_idstringrequiredread-only

The ID used to linked the portal application to an Identity Provider application.

registration_countnumberrequiredread-only

The number of product version registrations that are associated with the application. Registrations of any status are included in the count.

dcr_providerobject | nullrequired

Information about the DCR provider this application uses, if using DCR.

* Additional properties are NOT allowed.
Show Child Parameters
portalobjectrequired

Information about the portal the application is in.

* Additional properties are NOT allowed.
Show Child Parameters
developerobjectrequired

Information about the developer that owns the application.

* Additional properties are NOT allowed.
Show Child Parameters
auth_strategyOne Of
object
AuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
Show Child Parameters
granted_scopesarray | null[string]required

List of granted scopes for the application. Null if application type does not support returning granted scopes.

get/portals/{portalId}/applications/{applicationId}
 
application/json

Delete Application by Portal

Delete a single application in this portal, along with its registrations and credentials.

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

applicationIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

The application has been deleted.

delete/portals/{portalId}/applications/{applicationId}
 

Get Application

Returns the configuration of a single application in any portal. If an application is linked to a DCR Provider, the dcr_provider.id and reference_id can be used to correlate it. An application manages a set of credentials and registrations for specific API product versions.

get

Path Parameters

applicationIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

application/json

Details about an application in a portal.

GetApplicationResponse

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

namestringrequired

The unique (per developer) name of the application.

descriptionstring | nullrequired

A description of the application.

labelsobject | nullrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

reference_idstringrequiredread-only

The ID used to linked the portal application to an Identity Provider application.

registration_countnumberrequiredread-only

The number of product version registrations that are associated with the application. Registrations of any status are included in the count.

dcr_providerobject | nullrequired

Information about the DCR provider this application uses, if using DCR.

* Additional properties are NOT allowed.
Show Child Parameters
portalobjectrequired

Information about the portal the application is in.

* Additional properties are NOT allowed.
Show Child Parameters
developerobjectrequired

Information about the developer that owns the application.

* Additional properties are NOT allowed.
Show Child Parameters
auth_strategyOne Of
object
AuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
Show Child Parameters
granted_scopesarray | null[string]required

List of granted scopes for the application. Null if application type does not support returning granted scopes.

get/applications/{applicationId}
 
application/json

Portal Application Registrations

APIs related to Konnect Developer Portal Application Registrations.

List Application Registrations by Portal

Lists all of the application registrations and their current status (e.g., approved or pending) for this portal. Each registration is associated with a single API product version. Access is provided through the credentials issued to the application that contains each registration.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

Sorts a collection of application registrations. Supported sort attributes are:

  • created_at
  • updated_at
  • developer_id
  • status
filterobject

Filter application registrations returned in the response.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A paginated list of application registrations.

ListApplicationRegistrationsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

A application’s registration for a specific version of a product.

Example:{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"product":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Product"},"product_version":{"id":"74e54925-20a0-4788-9873-d24db33f1495","name":"v1"},"developer":{"id":"ecd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev"},"granted_scopes":["openid"],"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/application-registrations
 
application/json