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 the currently logged in developer can access.

get
/api/v3/applications

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filter[name][eq]string

Filter by direct equality comparison of the name property with a supplied value.

Example:good service

filter[name]string

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

Example:good service

filter[name][contains]string

Filter by contains comparison of the name property with a supplied substring

Example:good service

filter[auth_strategy_id][eq]string

Filter by the id of the auth strategy supported by the application.

Example:5be86298-147b-45ab-bfaf-a1bff97dce39

filter[auth_strategy_id]string

Filter by the id of the auth strategy supported by the application (short-hand).

Example:5be86298-147b-45ab-bfaf-a1bff97dce39

filter[team_id][eq]string | null(uuid)

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[team_id]string | null(uuid)

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[team_id][neq]string | null(uuid)

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[team_id][oeq]string

Filter by apps owned by any of the given teams (comma-separated UUIDs).

Example:5be86298-147b-45ab-bfaf-a1bff97dce39,7ce96398-247b-45ab-bfaf-b2c008e8f6e4

Response

application/json

Get applications response

ListApplicationsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
application/json

Create Application

Creates a new Application.

post
/api/v3/applications

Body

application/json

Create an application

CreateApplicationPayload

Application creation payload

* Additional properties are NOT allowed.
namestringrequired

The name of the application

<= 255 characters

client_idstring

A unique value used to identify the portal application when authenticating with a Client Secret.

<= 255 characters

redirect_uristring(uri)

URL to redirect to after completing an OIDC auth flow

descriptionstring

A brief description of the application

<= 255 characters

auth_strategy_idstring | null(uuid)

ID of the auth strategy to use for the application. If null or not included, the default application auth strategy will be used.

scopesarray[string]

The granted scopes for the application. Will only be included if supported by the application’s auth strategy.

team_idstring | null(uuid)

ID of the team to assign the application to.

Response

application/json

Application Creation success

ApplicationCreationResponse

Application creation response payload

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired
descriptionstring | nullrequired
redirect_uristring | null
client_idstring

A unique value used to identify the portal application when authenticating with a Client Secret.

<= 255 characters

client_secretstring

The client secret used to authenticate with registered APIs.

<= 255 characters

auth_strategyOne Of
objectrequired
PortalAuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

Show Child Parameters
scopesarray[string]

The granted scopes for the application. Will only be included if supported by the application’s auth strategy.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

team_idstring | null(uuid)

ID of the team to assign the application to.

application/json

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.

get
/api/v3/applications/{applicationId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Response

application/json

Get application response

GetApplicationResponse

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired
client_idstring

A unique value used to identify the portal application when authenticating with a Client Secret.

<= 255 characters

descriptionstring | nullrequired
redirect_uristring | null
auth_strategyOne Of
object
PortalAuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

Show Child Parameters
scopesarray[string]

The granted scopes for the application. Will only be included if supported by the application’s auth strategy.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

team_idstring | null(uuid)

ID of the team to assign the application to.

application/json

Delete Application

Deletes an application and all of its associated entities (registrations).

delete
/api/v3/applications/{applicationId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Response

Application was deleted successfully.