Get Usage of Applications - Cloud Security Gov

{"type":"api","title":"Get Usage of Applications","meta":{"id":"/apps/pubhub/media/cloud-security-gov/9ead083ce611c254ac9201d1e76003bd3d4b4b6b/ff5f351a-04ea-312e-8389-cac0236df6bd","info":{"title":"Cisco Secure Access for Government Application Lists API","version":"1.0.1","description":"Create and manage the application lists and internet destinations in the application lists for the organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Application Lists","description":"Manage the application lists and the internet destinations in the application lists."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/application-lists-overview.md","uri":"secure-access-api-reference-application-lists-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.secureaccessfed.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.secureaccessfed.cisco.com/auth/v2/token","scopes":{"policies.applicationlists:write":"Write policies application lists","policies.applicationlists:read":"Read policies application lists"}}}}}},"spec":{"summary":"Get Usage of Applications","operationId":"updateUsageApplications","tags":["Application Lists","Secure Access"],"description":"Get the list of application usage information for the application lists.","parameters":[{"name":"attributeName","in":"query","description":"Filter on the name of the rule attribute.","required":true,"schema":{"type":"string","enum":["umbrella.destination.application_ids"],"description":"The name of the attribute for use in the applications usage query parameter.","example":"umbrella.destination.application_ids","$$ref":"#/components/schemas/attributeNameInQuery"},"$$ref":"#/components/parameters/attributeName"},{"name":"attributeValue","in":"query","description":"Filter on the value of the rule attribute.","required":true,"schema":{"type":"string","description":"The comma-separated list of the application IDs.","items":{"type":"integer"},"example":"41,51","$$ref":"#/components/schemas/attributeValueInQuery"},"$$ref":"#/components/parameters/attributeValue"}],"security":[{"oauthFlow":["policies.applicationlists:read"]}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"array","description":"The list of application usage information.\nThe application usage information describes the relationships between the application and its application lists and access rules.","items":{"type":"object","description":"The information about the application usage.","properties":{"applicationId":{"type":"integer","description":"The ID of the application.","example":2453454,"$$ref":"#/components/schemas/applicationId"},"usedBy":{"type":"object","description":"The properties of the application lists that include the applications.","properties":{"applicationLists":{"type":"array","description":"The list of application list information.","items":{"type":"object","description":"The properties of the application List.","properties":{"applicationListId":{"type":"integer","description":"The ID of the application list.","example":1235,"$$ref":"#/components/schemas/applicationListId"},"usedByRules":{"type":"array","description":"The list of rule IDs that include the applications.","items":{"type":"integer","description":"The ID of the rule.","example":13455},"example":[13434,55666]},"applicationListName":{"type":"string","description":"The descriptive label for the application list.","example":"Application lists on branch_1.","$$ref":"#/components/schemas/applicationListName"},"applicationIds":{"type":"array","description":"The list of IDs for the applications.","items":{"type":"integer","description":"The ID of the application.","example":2453454,"$$ref":"#/components/schemas/applicationId"},"example":[1345,4666],"$$ref":"#/components/schemas/applicationIds"},"isRuleAssociated":{"type":"boolean","description":"Specifies whether the application list is associated with an access rule.","example":false}},"example":{"applicationListId":134,"usedByRules":[13456,45455],"applicationListName":"The name of the application list.","applicationIds":[40,43],"isRuleAssociated":true}},"example":[{"applicationListId":134,"usedByRules":[13456,45455],"applicationListName":"The name of the application list.","applicationIds":[40,43],"isRuleAssociated":true}]}},"example":{"applicationLists":[{"applicationListId":134,"usedByRules":[13456,45455],"applicationListName":"The name of the application list.","applicationIds":[40,43],"isRuleAssociated":true}]}}},"example":{"applicationId":40,"usedBy":{"applicationLists":[{"applicationListId":134,"usedByRules":[13456,45455],"applicationListName":"The name of the application list.","applicationIds":[40,43],"isRuleAssociated":true}]}}},"example":[{"applicationId":40,"usedBy":{"applicationLists":[{"applicationListId":15316,"applicationListName":"All Application Selection 3k","applicationIds":[40,43],"isRuleAssociated":true,"usedByRules":[]},{"applicationListId":14803,"applicationListName":"New Application List - 123","applicationIds":[40,43],"isRuleAssociated":true,"usedByRules":[]}]}},{"applicationId":43,"usedBy":{"applicationLists":[{"applicationListId":15316,"applicationListName":"All Application Selection 3k","applicationIds":[40,43],"isRuleAssociated":false,"usedByRules":[]},{"applicationListId":14803,"applicationListName":"New Application List - 123","applicationIds":[40,43],"isRuleAssociated":false,"usedByRules":[]}]}}],"$$ref":"#/components/schemas/ApplicationUsageResponse"},"example":[{"applicationId":40,"usedBy":{"applicationLists":[{"applicationListId":15316,"applicationListName":"All Application Selection 3k","applicationIds":[40,43],"isRuleAssociated":true,"usedByRules":[]},{"applicationListId":14803,"applicationListName":"New Application List - 123","applicationIds":[40,43],"isRuleAssociated":true,"usedByRules":[]}]}}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"The organization ID is a numeric value."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Authorized"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"updateUsageApplications","method":"get","path":"/applications/usage"}}