Get Portal Integration Configurations
Returns the portal integration configurations.
Path Parameters
ID of the portal.
Response
application/json
Response
The current integration configurations for a portal.
Portal Integrations
Configuration data for Dev Portal integrations
Default:{}
Google Tag Manager integration configuration
Show Child Parameters
Google Analytics integration configuration
Show Child Parameters
Authentication
Path Parameters
Replace Integration Configurations
Replace the portal integration configurations.
Path Parameters
ID of the portal.
Body
application/json
Body
Portal Integrations
Configuration data for Dev Portal integrations
Default:{}
Google Tag Manager integration configuration
Show Child Parameters
Google Analytics integration configuration
Show Child Parameters
Response
application/json
Response
The current integration configurations for a portal.
Portal Integrations
Configuration data for Dev Portal integrations
Default:{}
Google Tag Manager integration configuration
Show Child Parameters
Google Analytics integration configuration
Show Child Parameters
Authentication
Path Parameters
Body
Update Integration Configurations
Update the portal integration configurations, merging properties.
Path Parameters
ID of the portal.
Body
application/json
Body
Update Portal Integrations
Partially update configuration data for Dev Portal integrations
Default:{}
Partially update Google Tag Manager integration configuration
Show Child Parameters
Partially update Google Analytics 4 integration configuration
Show Child Parameters
Response
application/json
Response
The current integration configurations for a portal.
Portal Integrations
Configuration data for Dev Portal integrations
Default:{}
Google Tag Manager integration configuration
Show Child Parameters
Google Analytics integration configuration
Show Child Parameters
Authentication
Path Parameters
Body
Applications
APIs related to Konnect Developer Portal Applications.
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.