Portal Developer Applications (3.0.1)

Download OpenAPI specification:Download

N/A (this description is removed during bundling)

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

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

List applications the currently logged in developer can access.

Authorizations:

portalAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
filter[name][eq]	string Example: filter[name][eq]=good service Filter by direct equality comparison of the name property with a supplied value.
filter[name]	string Example: filter[name]=good service Filter by direct equality comparison (short-hand) of the name property with a supplied value.
filter[name][contains]	string Example: filter[name][contains]=good service Filter by contains comparison of the name property with a supplied substring
filter[auth_strategy_id][eq]	string Example: filter[auth_strategy_id][eq]=5be86298-147b-45ab-bfaf-a1bff97dce39 Filter by the id of the auth strategy supported by the application.
filter[auth_strategy_id]	string Example: filter[auth_strategy_id]=5be86298-147b-45ab-bfaf-a1bff97dce39 Filter by the id of the auth strategy supported by the application (short-hand).

Responses

Response samples

200
400
401

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "string",
"client_id": "string",
"description": "string",
"redirect_uri": "string",
"auth_strategy": {"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"name": "name",
"credential_type": "key_auth",
"key_names": ["apikey"
]
},
"scopes": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Create Application

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Creates a new Application.

Authorizations:

portalAccessToken

Request Body schema: application/json

Create an application

name required	string <= 255 characters The name of the application
client_id	string (ApplicationClientId) <= 255 characters A unique value used to identify the portal application when authenticating with a Client Secret.
redirect_uri	string <uri> URL to redirect to after completing an OIDC auth flow
description	string <= 255 characters A brief description of the application
auth_strategy_id	string or null <uuid> (AuthStrategyId) ID of the auth strategy to use for the application. If null or not included, the default application auth strategy will be used.
scopes	Array of strings (Scopes) Pre-release Endpoint This endpoint is currently in beta and is subject to change. The granted scopes for the application. Will only be included if supported by the application's auth strategy.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"client_id": "string",
"redirect_uri": "http://example.com",
"description": "string",
"auth_strategy_id": "e5dd1b68-9505-4524-a9e0-e088d563e7e6",
"scopes": ["string"
]
}

Response samples

Content type

application/json

{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "string",
"description": "string",
"redirect_uri": "string",
"client_id": "string",
"client_secret": "string",
"auth_strategy": {"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"name": "name",
"credential_type": "key_auth",
"key_names": ["apikey"
]
},
"scopes": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Fetch Application

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

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.

Authorizations:

portalAccessToken

path Parameters

applicationId

required

string <uuid>

Id of the targeted application

Responses

Response samples

200
400
401
404

Content type

application/json

{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "string",
"client_id": "string",
"description": "string",
"redirect_uri": "string",
"auth_strategy": {"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"name": "name",
"credential_type": "key_auth",
"key_names": ["apikey"
]
},
"scopes": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Application

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

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

Authorizations:

portalAccessToken

path Parameters

applicationId

required

string <uuid>

Id of the targeted application

Responses

Response samples

400
401
404
429

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}

Update Application

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Updates an application, replacing specified properties with any new values supplied in the request body.

Authorizations:

portalAccessToken

path Parameters

applicationId

required

string <uuid>

Id of the targeted application

Request Body schema: application/json

Update an application

name	string <= 255 characters The name of the application
client_id	string (ApplicationClientId) <= 255 characters A unique value used to identify the portal application when authenticating with a Client Secret.
redirect_uri	string <uri> URL to redirect to after completing an OIDC auth flow
description	string <= 255 characters A brief description of the application
scopes	Array of strings (Scopes) Pre-release Endpoint This endpoint is currently in beta and is subject to change. The granted scopes for the application. Will only be included if supported by the application's auth strategy.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"client_id": "string",
"redirect_uri": "http://example.com",
"description": "string",
"scopes": ["string"
]
}

Response samples

200
400
401
404
409

Content type

application/json

{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "string",
"client_id": "string",
"description": "A brief description of the application",
"redirect_uri": "https://example.com/callback",
"auth_strategy": {"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"name": "name",
"credential_type": "key_auth",
"key_names": ["apikey"
]
},
"scopes": ["string"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Available Auth Strategies

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Retrieve the auth strategies on this portal. An auth strategy represents the way your application provides credentials to authenticate with an API.

Authorizations:

portalAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
filter[name][eq]	string Example: filter[name][eq]=good service Filter by direct equality comparison of the name property with a supplied value.
filter[name]	string Example: filter[name]=good service Filter by direct equality comparison (short-hand) of the name property with a supplied value.
filter[name][contains]	string Example: filter[name][contains]=good service Filter by contains comparison of the name property with a supplied substring
filter[credential_type][eq]	string Enum: "client_credentials" "self_managed_client_credentials" "key_auth" Example: filter[credential_type][eq]=key_auth Filter by direct equality comparison of the credential_type with a supplied value.

Responses

Response samples

200
400
401

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
"name": "name",
"credential_type": "key_auth",
"key_names": ["apikey"
]
}
]
}

Credentials

The API for Konnect Portal developer credentials within a private portal (i.e. requires registration/authentication).

List Credentials

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Lists the credentials for an application. Basic information about the credential is returned, but not the credential secret itself.

Authorizations:

portalAccessToken

path Parameters

applicationId

required

string <uuid>

Id of the targeted application

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.

Responses

Response samples

200
400
404
409

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"display_name": "string"
}
]
}

Create Credential

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Allows a developer to create a credential for an application they own.

Authorizations:

portalAccessToken

path Parameters

applicationId

required

string <uuid>

Id of the targeted application

Request Body schema: application/json

Create a credential

display_name

string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"display_name": "string"
}

Response samples

201
400
401
403
404

Content type

application/json

{"credential": "string",
"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"display_name": "string"
}

Update Credential

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Updates a credential for an application owned by the current logged in developer.

Authorizations:

portalAccessToken

path Parameters

applicationId required	string <uuid> Id of the targeted application
credentialId required	string <uuid> Id of the targeted credential

Request Body schema: application/json

Update a credential

display_name

required

string <= 255 characters

Responses

Request samples

Payload

Content type

application/json

{"display_name": "string"
}

Response samples

400
401
404

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}

Delete Credential

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Deletes a credential for an application they own.

Authorizations:

portalAccessToken

path Parameters

applicationId required	string <uuid> Id of the targeted application
credentialId required	string <uuid> Id of the targeted credential

Responses

Response samples

400
401
404
409

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}