List Portal Roles
List roles that can be assigned to teams in a portal. Each role provides a set of permissions to perform an action on a resource.
Response
application/json
Response
A set of roles available in portals.
ListRolesResponse
The set of roles available to associate with resources and assign to teams.
Show Child Parameters
Authentication
Portal Applications
APIs related to Konnect Developer Portal Applications.
List Applications
Lists applications created by developers in this portal. Each application can be registered for various API Products (by version), issuing credentials for API request access. If using DCR, an application will be linked to an Identity Provider’s application by its reference_id.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Sorts a collection of applications. Supported sort attributes are:
- created_at
- developer_id
- name
Filter applications returned in the response.
Show Child Parameters
Path Parameters
ID of the portal.
Response
application/json
Response
A paginated list of applications in a portal.
ListApplicationsResponse
returns the pagination information
Show Child Parameters
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"}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
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.
Path Parameters
ID of the portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
Details about an application in a portal.
GetApplicationResponse
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The unique (per developer) name of the application.
A description of the application.
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"}
The ID used to linked the portal application to an Identity Provider application.
The number of product version registrations that are associated with the application. Registrations of any status are included in the count.
Information about the DCR provider this application uses, if using DCR.
Show Child Parameters
Information about the portal the application is in.
Show Child Parameters
Information about the developer that owns the application.
Show Child Parameters
One OfKeyAuth Auth strategy that the application uses.
Show Child Parameters
List of granted scopes for the application. Null if application type does not support returning granted scopes.
Authentication
Path Parameters
Delete Application by Portal
Delete a single application in this portal, along with its registrations and credentials.
Path Parameters
ID of the portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
Response
The application has been deleted.