Get applications by product version

Get applications that have a registration for a given product version. Any registration for the version will count, regardless of status (i.e. even if it is pending, rejected, or revoked).
Use the unregistered query param to return the inverse, only including applicatons that do not have a registration (regardless of status).

get
/api/v2/products/{productId}/versions/{productVersionId}/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[status][eq]string

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

Allowed values:approvedpendingrejectedrevoked

Example:approved

filter[status]string

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

Allowed values:approvedpendingrejectedrevoked

Example:approved

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

unregisteredboolean

Return applications that do not have a registration for the product version (regardless of registration status).

Path Parameters

productIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

productVersionIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Response

application/json

Paginated list of applications either registered or not registered for a product version.

ProductVersionListApplicationsPage

* 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

Get spec for product version

Returns the API specification document attached to given product version. Currently only OpenAPI is supported.

get
/api/v2/products/{productId}/versions/{productVersionId}/spec

Path Parameters

productIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

productVersionIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Response

application/json

Product version spec document.

ProductVersionSpecDocument

API specification document for a product version.

api_typestringrequired

Allowed values:openapi

contentstringrequired
application/json

Get operations in version spec

Returns list of operations used in the API specification document attached to given product version.

get
/api/v2/products/{productId}/versions/{productVersionId}/spec/operations

Path Parameters

productIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

productVersionIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Response

application/json

Product version spec operations.

ProductVersionSpecOperations

List of every operation detailed in a product version spec document.

api_typestringrequired

Allowed values:openapi

operationsarray[object]required
Show Child Parameters
application/json

documentation

The API for Konnect Portal API Documentation.

List product documents

Returns a list of documents that are associated with a given product. The list is paginated, and is in either a list or tree format (based on the Accept header).

get
/api/v2/products/{productId}/documents

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

Path Parameters

productIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Headers

Acceptstring

Allowed values:application/jsonapplication/vnd.konnect.document-tree+json

Default:application/json

Response

Lists documents for a given product.

ListDocuments

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

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