applications
The API for Konnect Portal developer applications within a private portal (i.e. requires registration/authentication). When a portal is in public mode, all of the described endpoints will return a 404 error. A public portal means that applications and registrations are not available/needed. In this API’s context, “you” and “your” refers to the developer consuming the API.
List Applications
List applications owned by the developer currently logged in.
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
Filter by direct equality comparison of the name property with a supplied value.
Example:good service
Filter by direct equality comparison (short-hand) of the name property with a supplied value.
Example:good service
Filter by contains comparison of the name property with a supplied substring
Example:good service
Filter by the id of the auth strategy supported by the application.
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by the id of the auth strategy supported by the application (short-hand).
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Response
application/json
Response
Get applications response
ListApplicationsResponse
returns the pagination information
Show Child Parameters
Show Child Parameters
Create an Application
Creates a new Application.
Body
application/json
Body
Create an application
CreateApplicationPayload
Application creation payload
The name of the application
<= 255 characters
An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.
<= 255 characters
URL to redirect to after completing an OIDC auth flow
A brief description of the application
<= 255 characters
ID of the auth strategy to use for the application. If null or not included, the default application auth strategy will be used.
The granted scopes for the application. Will only be included if supported by the application’s auth strategy.
Response
application/json
Response
Application Creation success
ApplicationCreationResponse
Application creation response payload
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.
<= 255 characters
Show Child Parameters
One OfKeyAuth Auth strategy that the application uses.
Show Child Parameters
The granted scopes for the application. Will only be included if supported by the application’s auth strategy.
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
Get an Application
Gets the details for an existing application. You need only supply the unique application identifier that was returned upon application creation or by the list-applications endpoint.
Path Parameters
Id of the targeted application
Response
application/json
Response
Get application response
GetApplicationResponse
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.
<= 255 characters
One OfKeyAuth Auth strategy that the application uses.
Show Child Parameters
The granted scopes for the application. Will only be included if supported by the application’s auth strategy.
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
Delete Application
Deletes an application and all of its associated entities (registrations).
Path Parameters
Id of the targeted application
Response
Response
Application was deleted successfully.