ListApplicationsResponse

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Example:{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"An easy to manage app in a Konnect developer portal","reference_id":"df66b180-97df-4ddb-8b45-8b7d5eac56da","registration_count":4,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"dcr_provider":null,"granted_scopes":null,"developer":{"id":"9cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev","email":"jane.developer@example.com"},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z"}

* Additional properties are NOT allowed.
Show Child Parameters
Example

PortalDeveloper

object
* 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

emailstring(email)required

<= 255 characters

full_namestringrequired

<= 255 characters

statusstringrequired

The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.

Allowed values:approvedpendingrevokedrejected

Example:approved

application_countnumberrequiredread-only

Example:4

Example

PortalDeveloper

object
* 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

emailstring(email)required

<= 255 characters

full_namestringrequired

<= 255 characters

statusstringrequired

The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.

Allowed values:approvedpendingrevokedrejected

Example:approved

application_countnumberrequiredread-only

Example:4

Example

Application

object
* 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.

descriptionstringrequired

A description of the application.

labelsobjectrequired

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_providerobjectrequired

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[string]required

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

Example

ListApplicationRegistrationsResponse

object
* 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
Example