{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs Applications API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "Applications", "type": "folder" }, "items": [ { "info": { "name": "Get an Application", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/applications/:applicationId", "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "ID of the application." } ] }, "docs": "Returns the configuration of a single application in any portal. If an application is linked to a DCR Provider, the `dcr_provider.id` and `client_id` can be used to correlate it. An application manages a set of credentials and registrations for specific APIs." }, { "info": { "name": "List Applications", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications", "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 applications. Supported sort attributes are:\n - created_at\n - developer_id\n - name\n" }, { "name": "filter", "value": "", "type": "query", "description": "Filter applications returned in the response." } ] }, "docs": "Lists applications in this portal. Each application can be registered for various APIs, issuing credentials for API access. If using DCR, an application will be linked to an Identity Provider's application by its `client_id`." }, { "info": { "name": "Get an Application by Portal", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications/:applicationId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "applicationId", "value": "", "type": "path", "description": "ID of the application." } ] }, "docs": "Returns the configuration of a single application in this portal. If an application is linked to a DCR Provider, the `dcr_provider.id` and `client_id` can be used to correlate it. An application manages a set of credentials and registrations for specific APIs." }, { "info": { "name": "Update Application", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications/:applicationId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "applicationId", "value": "", "type": "path", "description": "ID of the application." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an application." }, { "info": { "name": "Delete Application by Portal", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications/:applicationId", "params": [ { "name": "portalId", "value": "", "type": "path", "description": "ID of the portal." }, { "name": "applicationId", "value": "", "type": "path", "description": "ID of the application." } ] }, "docs": "Delete a single application in this portal, along with its registrations and credentials." }, { "info": { "name": "List Credentials by Application", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications/:applicationId/credentials", "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." } ] }, "docs": "Lists all credentials for an application. This endpoint returns both API key credentials and DCR credentials, depending on the auth strategy the application uses: - For DCR applications: Credential information is retrieved from the identity provider using provider-specific APIs - For Key-Auth applications: Returns information about credentials Basic information about the credential is returned, but not the credential secret itself." }, { "info": { "name": "List Developers by Application", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/applications/:applicationId/developers", "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 developers for an application. Supported sort attributes are:\n\n\n - id\n" }, { "name": "filter", "value": "", "type": "query", "description": "Filter application developers returned in the response." } ] }, "docs": "Lists each developer that can access the given application for this portal." } ] } ], "bundled": true }