Apps Endpoint

Apps Firewall

This endpoint applies to the Apps Firewall product

The apps endpoint returns all of an organization's installed applications as well as their current status. To get uninstalled applications use the install_state filter.

Field ID
Type
Description

id

string

The application's internal Cloudlock id

app

resource

Information regarding the application. See the app general resource

scope_categories

resource

The applications scope categories. See the scope_categories general resource

classification

resource

Applications classification resource. See the classification general resource

detected_at

timestamp

Time the app was detected, in UTC

users_count

integer

Number of users that have the application installed

admins_count

integer

Number of administrators that have the application installed

Apps Filters

Filter
Usage
Example

limit

Determine how many incidents to return

offset

To indicate the item number to start the result set from

classification

Filter based on the applications classification

vendor

Filter based on the vendor platform

app_category

The category the application belongs to

detected_at_after

See which applications were detected after a given date

detected_at_before

See which applications were detected before a given date

app_ids

Return one app/multiple apps based on their id

scope_categories

Return applications based on their scope category. Use a comma "," to AND scope categories in a search for apps that have multiple scope categories

install_state

Return applications based on their state (installed or not installed).

count_total

Determines whether the "total" field returns a valid count of how many applications there are so that you can page through them using the "offset". Default value is "false". Set to "true" to return a valid apps count.

Return Apps

[/apps{?classification}]
List all of an organization's applications [GET]

  • Parameters
    • classification (optional, options, trusted ) ¦.
  • Response 200 (application/json)
{
  "limit": 2,
  "offset": 0,
  "total": 45,
  "results": 2,
  "items": [
   {
    "id": "RkJx2JxK2O",
    "app": {
     "id": "RkJx2JxK2O",
     "name": "Cloudlock",
     "vendor": {
      "name": "google"
     },
     "trust_rating": null,
     "category": null,
     "origin_id": "144711811583-2ra0eotmtsb3p7f48eie68d4rfeghl7q.apps.googleusercontent.com",
     "install_type": "user",
     "is_revokable": true
    },
    "scope_categories": [
     "BINFO"
    ],
    "classification": {
     "reason": "",
     "updated_at": null,
     "method": "",
     "type": "unclassified"
    },
    "detected_at": "2016-02-19T08:22:40.382224+00:00",
    "users_count": 3,
    "admins_count": 0
   },
   {
    "id": "6yj3gQxaqo",
    "app": {
     "id": "6yj3gQxaqo",
     "name": "Cacoo",
     "vendor": {
      "name": "google"
     },
     "trust_rating": null,
     "category": null,
     "origin_id": "966566793553-e7pb5hvq94b54m7ce99cmlflvfdemi9h.apps.googleusercontent.com",
     "install_type": "user",
     "is_revokable": true
    },
    "scope_categories": [
     "BINFO"
    ],
    "classification": {
     "reason": "",
     "updated_at": null,
     "method": "",
     "type": "unclassified"
    },
    "detected_at": "2018-04-21T08:22:40.506392+00:00",
    "users_count": 1,
    "admins_count": 0
   }
  ]
 }

Change App Classification

[/apps/{id}/classification]
Update an apps classification [POST]

  • Request (application/json)
{"type": "trusted", "reason_id": 4,"other_reason" : "Other Custom Reason"}
  • Parameters
    • id (required, string, Aj54oPkx8m ) ¦ id of the Incident.
  • Response 200 (application/json)
    • Header
    • Body
{
 "id": "Aj54oPkx8m",
 "app": {
  "id": "Aj54oPkx8m",
  "name": "Random Google App",
  "vendor": {
   "name": "google"
  },
  "category": null,
  "origin_id": "150079143025-d1lebr0q2pdf3i9vp2o3gb9dhm6nahq1.apps.googleusercontent.com",
  "install_type": "user",
  "is_revokable": true
 },
 "scope_categories": [
  "BINFO"
 ],
 "classification": {
  "reason_id": 4,
  "reason": "Internal reason",
  "updated_at": "2016-01-17T20:43:08.465267+00:00",
  "method": "manual",
  "type": "trusted",
  "other_reason": "Other Custom Reason"
 },
 "detected_at": "2018-04-13T11:54:47.403000+00:00",
 "users_count": 1
}

Get an Application's Access Scopes

[/apps/{id}/access_scopes]
The access_scopes endpoint returns all of the access scopes for a given application (based on the application id).

id

integer

The internal Cloudlock id for the access scope

description

string

A verbose description of the access scope. For example: View your email address

friendly_name

string

The name of the access scope (in the UI this is the ˜ACCESS SCOPE in the Access Scopes table). For example: Userinfo - Email

url

string

The url to the access scope. For example: https://www.googleapis.com/auth/userinfo.email

category

resource

The scope category the access scope belongs to. See the scope_categories general resource

List Access Scopes

List all of an application's access scopes [GET]

  • Parameters
    • id (required, string, G8qz0A239V ) ¦ id of the app.
  • Response 200 (application/json)
{
 "limit": 20,
 "offset": 0,
 "total": 7,
 "results": 7,
 "items": [
  {
   "id": "1gk4vvW4Mq",
   "description": "View your email address",
   "friendly_name": "Userinfo - Email",
   "url": "https://www.googleapis.com/auth/userinfo.email",
   "category": {
    "id": "BINFO",
    "title": "Basic Information"
   }
  },
  {
   "id": "eyaznabxYK",
   "description": "View and manage your +1s, posts, friends, pages, and circles.",
   "friendly_name": "Google+",
   "url": "https://www.googleapis.com/auth/plus.me",
   "category": {
    "id": "BINFO",
    "title": "Basic Information"
   }
  },
  {
   "id": "A1MxyBrzBj",
   "description": "Know your basic profile info and list of people in your circles.",
   "friendly_name": "Google+ API: Login Information",
   "url": "https://www.googleapis.com/auth/plus.login",
   "category": {
    "id": "LACES",
    "title": "Limited Access to Data and Files"
   }
  },
  {
   "id": "ZkL4dryz1o",
   "description": "Insert moments to a Google+ profile.",
   "friendly_name": "Google+ API: Moments",
   "url": "https://www.googleapis.com/auth/plus.moments.write",
   "category": {
    "id": "LACES",
    "title": "Limited Access to Data and Files"
   }
  },
  {
   "id": "oLZ48wd3ev",
   "description": "Retrieves the Google+ profile language.",
   "friendly_name": "Google+ API: Profile Language",
   "url": "https://www.googleapis.com/auth/plus.profile.language.read",
   "category": {
    "id": "LACES",
    "title": "Limited Access to Data and Files"
   }
  },
  {
   "id": "ebR4qyy4vA",
   "description": "",
   "friendly_name": "Google+",
   "url": "https://www.googleapis.com/auth/plus.profile.agerange.read",
   "category": {
    "id": "LACES",
    "title": "Limited Access to Data and Files"
   }
  },
  {
   "id": "5LZzKRoxbK",
   "description": "Retrieves the Google+ circle members.",
   "friendly_name": "Google+ API: Circles Read Only",
   "url": "https://www.googleapis.com/auth/plus.circles.members.read",
   "category": {
    "id": "LACES",
    "title": "Limited Access to Data and Files"
   }
  }
 ]
}

Get App Installs

[/apps/{id}/installs]
The installs endpoint returns all of the installs for a given application based on the application id.

Field ID
Type
Description

detection_date

timestamp

The time the app was detected, in UTC

state

string

State of installation, e.g. "Installed", "Not installed"

domain

string

The domain in which the app was installed, e.g. "http://mycompany.com"

scope_type

string

The scope of the installation, e.g. "user"

scope_value

string

ID of the installation owner

given_name

string

User name

family_name

string

User name

scope_id

integer

Unique identifier

app

App resource

list of app resources (see below)

App Resource

Field ID
Type

id

string

name

string

vendor

resource

category

string

origin_id

string

install_type

string

client_type

string

is_revokable

boolean

trust_rating

integer

risk_level

integer

access_risk

integer

List Installs

List all of an application's installs [GET]

  • Parameters
    • id (required, string, G8qz0A239V ) ¦ id of the app.
  • Response 200 (application/json)
{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": 1,
  "items": [
  {
    "detection_date": "2018-04-07T07:42:11.452682+00:00",
    "state": "not_installed",
    "domain": "cloudlockdemo.com",
    "scope_type": "user",
    "scope_value": "[email protected]",
    "given_name": "Admin",
    "family_name": "Admin",
    "scope_id": 15926475,
    "app": {
      "id": "rNP3DKdzBy",
      "name": "Balsamiq Mockups 3 for Google Drive",
      "vendor": {
        "name": "google"
      },
      "category": null,
      "origin_id": "199991064517-4p9fkqt42jbsg361b4lu8fsuob161vhn.apps.googleusercontent.com",
      "install_type": "user",
      "client_type": "not_native",
      "is_revokable": true,
      "trust_rating": 100,
      "risk_level": 1,
      "access_risk": 2
    }
  }
]
}

Updated about a year ago

Apps Endpoint


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.