Application Registrations
APIs related to Konnect Developer Portal Application Registrations.
List Registrations by Portal
Lists all of the application registrations and their current status (e.g., approved or pending) for this portal. Each registration is associated with a single API. Access is provided through the credentials issued to the application that contains each registration.
Query Parameters
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
Sorts a collection of application registrations. Supported sort attributes are:
- created_at
- updated_at
- developer_id
- status
Filter application registrations returned in the response.
Show Child Parameters
Path Parameters
ID of the portal.
Response
application/json
Response
A paginated list of application registrations.
ListApplicationRegistrationsResponse
returns the pagination information
Show Child Parameters
A application’s registration for a specific version of an API.
Example:{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"api":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
List Registrations by Application
Lists each API that this application is registered for and their current status (e.g., pending, approved, rejected, revoked).
Query Parameters
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
Sorts a set of registrations for an application. Supported sort attributes are:
- created_at
- updated_at
- status
Filter application registrations returned in the response.
Show Child Parameters
Path Parameters
ID of the portal.
ID of the application.
Response
application/json
Response
A paginated list of application registrations.
ListApplicationRegistrationsResponse
returns the pagination information
Show Child Parameters
A application’s registration for a specific version of an API.
Example:{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"api":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get a Registration
Returns information about an application’s registration status for a particular API.
Path Parameters
ID of the portal.
ID of the application.
ID of the application registration.
Response
application/json
Response
Details about an application registration.
GetApplicationRegistrationResponse
A application’s registration for a specific version of an API.
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 status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the API.
Allowed values:approvedpendingrevokedrejected
Example:approved
Details about the API the application is registered to.
Show Child Parameters
Details about the application the registration is part of.
Show Child Parameters
Authentication
Path Parameters
Update Registration
Updates the status of a particular application registration to an API. Approved application registrations will allow API traffic to the corresponding API. Revoked, rejected, or pending will not allow API traffic.
Path Parameters
ID of the portal.
ID of the application.
ID of the application registration.
Body
application/json
Body
Update an application registration.
UpdateApplicationRegistrationRequest
The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the API.
Allowed values:approvedpendingrevokedrejected
Example:approved
Response
application/json
Response
Details about the application registration being updated.
UpdateApplicationRegistrationResponse
A application’s registration for a specific version of an API.
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 status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the API.
Allowed values:approvedpendingrevokedrejected
Example:approved
Details about the API the application is registered to.
Show Child Parameters
Details about the application the registration is part of.