Applications
List Applications
Lists applications in this portal. Each 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.
get/v3/portals/{portalId}/applications
Path parameters
portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a
ID of the portal.
Query parameters
page[size]integer
Example:10
The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]integer
Example:1
Determines which page of the entities to retrieve.
sortstring
Sorts a collection of applications. Supported sort attributes are:
- created_at
- developer_id
- name
Filter applications returned in the response.
Response
A paginated list of applications in a portal.
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 2
}
},
"data": [
{
"id": "b15e2460-ba40-431d-9df0-4957fcffacda",
"labels": {
"env": "test"
},
"name": "App 1",
"description": "An easy to manage app in a Konnect developer portal",
"registration_count": 2,
"portal": {
"id": "95606071-49c7-4c2e-ae49-8a86d72a8110"
},
"auth_strategy": {
"id": "85606071-49c7-4c2e-ae49-8a86d72a8110",
"name": "API Key",
"credential_type": "key_auth",
"key_names": [
"apikey"
]
},
"created_at": "2022-12-22T19:09:30.712Z",
"updated_at": "2022-12-22T19:09:30.712Z"
},
{
"id": "b15e2460-ba40-431d-9df0-4957fcffacda",
"labels": {
"env": "test"
},
"name": "App 1",
"description": "A Konnect application that is linked to an Identity Provider application using Dynamic Client Registration (DCR)",
"client_id": "yr1k0d9kj3l0cl01hp4o0",
"registration_count": 3,
"portal": {
"id": "95606071-49c7-4c2e-ae49-8a86d72a8110"
},
"auth_strategy": {
"id": "65606071-49c7-4c2e-ae49-8a86d72a8110",
"name": "Client Credentials",
"credential_type": "client_credentials",
"auth_methods": [
"client_credentials",
"bearer",
"session"
]
},
"dcr_provider": {
"id": "7ea06071-49c7-4c2e-ae49-8a86d72a8110"
},
"granted_scopes": null,
"created_at": "2022-12-22T19:07:30.712Z",
"updated_at": "2022-12-22T19:07:30.712Z"
}
]
}