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 application registrations. If the portal is public
all of the described endpoints will return a 404 error
Lists product registrations for an application.
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 id property with a supplied value.
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by direct equality comparison (short-hand) of the id property with a supplied value.
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by direct equality comparison of the status property with a supplied value.
Allowed values:approvedpendingrejectedrevoked
Example:approved
Filter by direct equality comparison (short-hand) of the status property with a supplied value.
Allowed values:approvedpendingrejectedrevoked
Example:approved
Filter by direct equality comparison of the product_name property with a supplied value.
Example:good service
Filter by direct equality comparison (short-hand) of the product_name property with a supplied value.
Example:good service
Filter by direct equality comparison of the product_version_name property with a supplied value.
Example:good service
Filter by direct equality comparison (short-hand) of the product_version_name property with a supplied value.
Example:good service
Filter by contains comparison of the product_version_name property with a supplied substring
Example:good service
Filter by contains comparison of the product_name property with a supplied substring
Example:good service
Id of the targeted application
Get registrations response.
returns the pagination information
Registers an application for a product.
Id of the targeted application
Create an application registration.
The payload to create a registration.
The product version id required for registration.
The requested scopes for the registration, requires developer_managed_scopes to be enabled.
Registration creation response.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
The approval status of the registration.
Allowed values:approvedpendingrejectedrevoked
Contains a unique identifier used by the Portal API for this resource.
The name of the product. This is the name that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
The name of the product version. This is the version label that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
Cached list of scopes granted for the given application registration.
Use /api/v2/applications/{applicationId}/registrations/{registrationId}/granted-scopes to get up to date granted scopes from the IDP.
This property will be omitted if not supported by the application.
Retrieves the specified product registration for an application.
Id of the targeted application
Contains a unique identifier used by the Portal API for this resource.
Get registration response.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
The approval status of the registration.
Allowed values:approvedpendingrejectedrevoked
Contains a unique identifier used by the Portal API for this resource.
The name of the product. This is the name that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
The name of the product version. This is the version label that is displayed in the developer portal.
Contains a unique identifier used by the Portal API for this resource.
Cached list of scopes granted for the given application registration.
Use /api/v2/applications/{applicationId}/registrations/{registrationId}/granted-scopes to get up to date granted scopes from the IDP.
This property will be omitted if not supported by the application.