{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Application Registrations API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Application Registrations", "type": "folder" }, "items": [ { "info": { "name": "List Registrations by Portal", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/application-registrations", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "page[size]", "value": "", "type": "query", "description": "The maximum number of items to include per page. The last page of a collection may include fewer items." }, { "name": "page[number]", "value": "", "type": "query", "description": "Determines which page of the entities to retrieve." }, { "name": "sort", "value": "", "type": "query", "description": "Sorts a collection of application registrations. Supported sort attributes are:\n\n\n - created_at\n - updated_at\n - developer_id\n - status\n" }, { "name": "filter", "value": "", "type": "query", "description": "Filter application registrations returned in the response." } ] }, "docs": "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." }, { "info": { "name": "List Registrations by Application", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications/:applicationId/registrations", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "applicationId", "value": "", "type": "path", "description": "ID of the application." }, { "name": "page[size]", "value": "", "type": "query", "description": "The maximum number of items to include per page. The last page of a collection may include fewer items." }, { "name": "page[number]", "value": "", "type": "query", "description": "Determines which page of the entities to retrieve." }, { "name": "sort", "value": "", "type": "query", "description": "Sorts a set of registrations for an application. Supported sort attributes are:\n\n\n - created_at\n - updated_at\n - status\n" }, { "name": "filter", "value": "", "type": "query", "description": "Filter application registrations returned in the response." } ] }, "docs": "Lists each API that this application is registered for and their current status (e.g., pending, approved, rejected, revoked)." }, { "info": { "name": "Get a Registration", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications/:applicationId/registrations/:registrationId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "applicationId", "value": "", "type": "path", "description": "ID of the application." }, { "name": "registrationId", "value": "", "type": "path", "description": "ID of the application registration." } ] }, "docs": "Returns information about an application's registration status for a particular API." }, { "info": { "name": "Update Registration", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications/:applicationId/registrations/:registrationId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "applicationId", "value": "", "type": "path", "description": "ID of the application." }, { "name": "registrationId", "value": "", "type": "path", "description": "ID of the application registration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete Registration", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications/:applicationId/registrations/:registrationId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "applicationId", "value": "", "type": "path", "description": "ID of the application." }, { "name": "registrationId", "value": "", "type": "path", "description": "ID of the application registration." } ] }, "docs": "Deletes an application registration, which if currently approved will immediately block API traffic to the API.\nNote: Developers can request a new application registration for the given API as long as they have RBAC access to consume." } ] } ], "bundled": true }