Create Application
Creates a new application for this portal. The application must be assigned to a developer or a team. An application can be registered for various APIs, issuing credentials for API access. If using DCR, an application will be linked to an Identity Provider’s application by its client_id.
Path Parameters
ID of the portal.
Body
application/json
Body
Create an application for a portal.
CreateApplicationRequest
The name of the application.
<= 255 characters
A description of the application.
<= 255 characters
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"}
If using a DCR auth strategy, set this property to link the portal application to an existing
client from the DCR provider, instead of having Konnect create a new client.
This allows importing existing clients from an Identity Provider into Konnect, allowing
them to be controlled through the DCR flows in the portal, and use existing client secrets
for API access.
The value must be a valid client ID in the DCR provider associated with the auth strategy.
If it is not valid, application will be created but will not function properly.
<= 255 characters
An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.
<= 255 characters
The ID of the authentication strategy the application will use when making requests to registered APIs.
Show Child Parameters
Response
application/json
Response
Details about an application in a portal.
GetApplicationResponse
One OfContains 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 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 API 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
Client Credential 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.
Show Child Parameters
Authentication
Path Parameters
Body
Add Developer to Application
Add a developer as an owner of the application.
Path Parameters
ID of the portal.
ID of the application.
ID of the developer.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
Details about a developer of an application.
ApplicationDeveloperDetailed
List of developers that have a registered application.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
<= 250 characters
Example:developer@email.com
Match pattern:^[\w \W]+$
<= 250 characters
Example:API Developer
Authentication
Path Parameters
Remove Developer from Application
Remove a developer from an application. There must be at least one remaining owner.
Path Parameters
ID of the portal.
ID of the application.
ID of the developer.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
No Content
Authentication
Path Parameters
Application Registrations
APIs related to Konnect Developer Portal Application Registrations.
Create Registration
Creates a new registration for this application to access a specific API. Registrations created through the portal management API will respect the auto-approve settings of the portal and/or API publication. API publications that do not use auto-approve must be manually approved by an administrator after creation.
Path Parameters
ID of the portal.
ID of the application.
Body
application/json
Body
Create an application registration for a portal application.
CreateApplicationRegistrationRequest
The ID of the API the application is registering for.
The status of the application registration. It must be a valid status value for a registration creation.
Allowed values:approvedpending
Example:approved
Response
application/json
Response
Details about an application registration.
GetApplicationRegistrationResponse
A application’s registration for a specific version of an API.
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 status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the API.
Allowed values:approvedpendingrevokedrejected
Example:approved
Details about the API the application is registered to.
Show Child Parameters
Details about the application the registration is part of.