List Applications for the Organization - Cloud Security API

{"type":"api","title":"List Applications for the Organization","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/eadd0b56-ea60-32bd-a1aa-155c29b52bed","info":{"title":"Cisco Cloudlock API","description":"The Cloudlock API provides data about an organization's activities, apps, incidents, and policies.","version":"1.0.0","contact":{"name":"Cloud Security Developer Community"}},"tags":[{"name":"Activities"},{"name":"Apps"},{"name":"Entities"},{"name":"Incidents"},{"name":"Incident Aggregates"},{"name":"Incident Entities"},{"name":"IP Libraries"},{"name":"Policies"}],"openapi":"3.0.0","servers":[{"url":"https://api.cloudlock.com/api/v2"}]},"spec":{"tags":["Apps"],"description":"Get all of the organization's installed applications and their current status.\nTo get the uninstalled applications, use the `install_state` filter.","operationId":"listApplications","summary":"List Applications for the Organization","parameters":[{"name":"limit","in":"query","description":"The maximum number of records to return in the collection.","required":false,"schema":{"type":"string"},"$$ref":"#/components/parameters/limitParam"},{"name":"offset","schema":{"type":"string"},"in":"query","description":"A number that represents the index into the collection.","required":false,"$$ref":"#/components/parameters/offsetParam"},{"name":"classification","schema":{"type":"string"},"in":"query","description":"Filter based on the application classification","example":"trusted"},{"name":"vendor","schema":{"type":"string"},"in":"query","description":"Filter based on the vendor platform.","example":"google"},{"name":"app_category","schema":{"type":"string"},"in":"query","description":"The application category.","example":"CIT"},{"name":"detected_at_after","schema":{"type":"string"},"in":"query","description":"Specify a timestamp. Filter for applications detected after a given date.","example":"2021-04-21T08:22:40"},{"name":"detected_at_before","schema":{"type":"string"},"in":"query","description":"Specify a timestamp. Filter for applications detected before a given date.","example":"2021-04-21T08:22:40"},{"name":"app_ids","schema":{"type":"string"},"in":"query","description":"Filter for applications based on their id. Provide a comma-delimited string of IDs.","example":"1,2,3"},{"name":"scope_categories","schema":{"type":"string"},"in":"query","description":"Filter for applications based on their scope category. Provide a comma-delimited string of scope category.","example":"LACES,BINFO"},{"name":"install_state","schema":{"type":"string"},"in":"query","description":"Filter for applications based on their state (installed or not installed).","example":"installed"},{"name":"count_total","schema":{"type":"string"},"in":"query","description":"Determines whether the `total` field returns a valid count of the applications.\nUse the `count_total` value with the `offset` parameter to paginate the results.\nDefault value is `false`. Set to `true` to return a valid apps count.","example":"true"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The application's internal CloudLock ID."},"app":{"type":"object","description":"The information about the application.","properties":{"category":{"type":"string","description":"The app's category."},"id":{"type":"string","description":"The internal Cloudlock id for the application."},"install_type":{"type":"string","description":"A string that describes the installation type (across the domain or by a user). Possible values are: domain_wide, user."},"is_revokable":{"type":"boolean","description":"Indicates whether the app can be revoked."},"name":{"type":"string","description":"The name of the application, for example: Google Drive."},"origin_id":{"type":"string","description":"The location where the app was installed."},"trust_rating":{"type":"string","description":"The community trust rating score."},"vendor":{"type":"object","properties":{"name":{"type":"string","description":"The name of the vendor. For example: google."}},"$$ref":"#/components/schemas/Vendor"}},"$$ref":"#/components/schemas/App"},"scope_categories":{"type":"array","items":{"type":"object","description":"The scope categories resource returns information on the access scopes, which exist per each category.\nScope category strings: `FDATA` (full data access), `BINFO` (basic info), `LACES` (limited access to data and files),\n`PINFO` (payment information), and `INBO`X (access inbox or contact information).","properties":{"title":{"type":"string","description":"The categories title, for example: `Basic Information`."},"category_id":{"type":"string","description":"The category id. For example: `FDATA`, `BINFO`, `LACES`, and `PINFO`.","example":"FDATA"}},"$$ref":"#/components/schemas/ScopeCategory"},"description":"The list of application scope category."},"classification":{"type":"object","properties":{"method":{"type":"string","description":"The method where the classification was changed. Possible values are: manual, policy."},"reason":{"type":"string","description":"The reason for the classification."},"type":{"type":"string","description":"Application's classification type. Possible values are: unclassified, trusted, restricted, banned."},"updated_at":{"type":"string","description":"The classification's last update time, specified as a timestamp in UTC."}},"description":"The application's classification resource.","$$ref":"#/components/schemas/Classification"},"detected_at":{"type":"string","description":"The time when the app was detected, specified as a timestamp in UTC."},"users_count":{"type":"integer","description":"The number of users that have the application installed."},"admins_count":{"type":"integer","description":"The number of administrators that have the application installed."}},"$$ref":"#/components/schemas/AppsCollection"}},"examples":{"response":{"value":[{"admins_count":0,"app":{"category":"","id":"RkJx2JxK2O","install_type":"user","is_revokable":true,"name":"Cloudlock","origin_id":"144711811583-2ra0eotmtsb3p7f48eie68d4rfeghl7q.apps.googleusercontent.com","trust_rating":"","vendor":{"name":"google"}},"classification":{"method":"","reason":"","type":"unclassified","updated_at":""},"detected_at":"2016-02-19T08:22:40.382224+00:00","id":"RkJx2JxK2O","scope_categories":[{"category_id":"BINFO","title":"Basic information"}],"users_count":3}]}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"listApplications","method":"get","path":"/apps"}}