N/A (this description is removed during bundling)
portalAccessToken (apiKey)
The Developer portal cookie is meant to be used by the Developer API to authenticate with.
N/A (this description is removed during bundling)
The Developer portal cookie is meant to be used by the Developer API to authenticate with.
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 the currently logged in developer can access.
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
Filter by the team that owns the application. Use a team UUID or the literal string null for individually owned apps (e.g. filter[team_id][eq]=null).
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by the team that owns the application (short-hand). Use a team UUID or the literal string null for individually owned apps (e.g. filter[team_id]=null).
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by excluding a team. Use the literal string null to get only team-owned apps (excludes individually owned) (e.g. filter[team_id][neq]=null).
Example:null
Filter by apps owned by any of the given teams (comma-separated UUIDs).
Example:5be86298-147b-45ab-bfaf-a1bff97dce39,7ce96398-247b-45ab-bfaf-b2c008e8f6e4
Get applications response
returns the pagination information
Creates a new Application.
Create an application
Application creation payload
The name of the application
<= 255 characters
A unique value used to identify the portal application when authenticating with a Client Secret.
<= 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.
ID of the team to assign the application to.
Application Creation success
Application creation response payload
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
A unique value used to identify the portal application when authenticating with a Client Secret.
<= 255 characters
The client secret used to authenticate with registered APIs.
<= 255 characters
One OfKeyAuth Auth strategy that the application uses.
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
ID of the team to assign the application to.
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.
Id of the targeted application
Get application response
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
A unique value used to identify the portal application when authenticating with a Client Secret.
<= 255 characters
One OfKeyAuth Auth strategy that the application uses.
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
ID of the team to assign the application to.