Update Application Registration
Updates the status of a particular application registration to an API Product Version. 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.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
Update an application registration.
UpdateApplicationRegistrationRequest
The status of an application registration request. Each registration is linked to a single version of a product, and application credentials will not grant access to the product version until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the product version.
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 a product.
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 version of a product, and application credentials will not grant access to the product version until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the product version.
Allowed values:approvedpendingrevokedrejected
Example:approved
Details about the product the application is registered to.
Show Child Parameters
Details about the version of the product the application is registered to.
Show Child Parameters
Details about the application the registration is part of.
Show Child Parameters
Details about the developer that owns the application the registration is part of.
Show Child Parameters
Cached list of granted scopes for the registration. Identical for all registrations of an applications, use /portals/{portalId}/applications/{applicationId} to get up to date granted scopes from the IDP. Null if application type does not support returning granted scopes.
Authentication
Path Parameters
Body
Delete Application Registration
Deletes an application registration, which if currently approved will immediately block API traffic to the API product version.
Note: Developers can request a new application registration for the given API product version as long as they have RBAC access to consume.
Path Parameters
ID of the portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
Response
No Content
Authentication
Path Parameters
List Granted Scopes
Lists the granted scopes for this application registration. This is the list of scopes that will be sent to the API when making requests.
Path Parameters
ID of the portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
application/json
Response
A list of granted scopes for an application registration.
ListGrantedScopesResponse
Authentication
Path Parameters
Portal Products
APIs related to API Products Published to Konnect Developer Portals.
List Portal Products
Lists the API products that are published to this developer portal. An API product packages together multiple versions of each API, displaying each version with its set of operations and documentation. Developers can browse API Products to learn about and register for them. API Products access can be limited to certain developers using RBAC and developer teams.
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 Portal Products. Supported sort attributes are:
- created_at
- name
- description
Filters a collection of Portal Products.
Show Child Parameters
Path Parameters
ID of the portal.
Response
application/json
Response
A paginated list of API products published to a portal.
ListPortalProductsResponse
A paginated list of API products published to a portal.
returns the pagination information
Show Child Parameters
Example:{"id":"7cdcba18-5bdf-4936-81de-d76da02cb99b","name":"Excellent API","description":"Excellent for serving","created_at":"2022-05-24T18:40:35.500Z","updated_at":"2022-05-24T18:40:35.500Z","portal_ids":["83f1733c-862c-43e5-a005-acfb0addfcfb"],"labels":{"department":"marketing"},"version_count":4}