Update Application
Updates an application.
Path Parameters
ID of the portal.
ID of the application.
Body
application/json
Body
Update an application.
UpdateApplicationRequest
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
Delete Application by Portal
Delete a single application in this portal, along with its registrations and credentials.
Path Parameters
ID of the portal.
ID of the application.
Response
Response
The application has been deleted.
Authentication
Path Parameters
List Developers by Application
Lists each developer that can access the given application for this portal.
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 set of developers for an application. Supported sort attributes are:
- id
Filter application developers returned in the response.
Show Child Parameters
Path Parameters
ID of the portal.
ID of the application.
Response
application/json
Response
A paginated list developers of an application.
ListApplicationDevelopersResponse
returns the pagination information
Show Child Parameters
List of developers that have a registered application.
Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"API Developer"}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get an 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 client_id can be used to correlate it. An application manages a set of credentials and registrations for specific APIs.
Path Parameters
ID of the application.
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
List Credentials by Application
Lists all credentials for an application. This endpoint returns both API key credentials and DCR credentials, depending on the auth strategy the application uses: - For DCR applications: Credential information is retrieved from the identity provider using provider-specific APIs - For Key-Auth applications: Returns information about credentials Basic information about the credential is returned, but not the credential secret itself.
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
Path Parameters
ID of the portal.
ID of the application.
Response
application/json
Response
A paginated list of credentials for an application.
ListCredentialsResponse
returns the pagination information
Show Child Parameters
One OfAPI key credential returned when listing credentials.