Resources Returned via API

The following are resources returned by the API but not exposed as endpoints. Each listed resource includes an example of an endpoint that may include it. Resources include:

Entity

An Entity represents an object in the vendor (the vendor is the source application, e.g. Google Drive, Salesforce, etc.)

Field ID
Type
Description

id

string

This is Cloudlock Internal Identifier for an entity

name

string

Name of the underlying object represented by this entity

mime_type

string

The mime type of the object/document (if any)

owner_email

string

Object owner's email address (e.g. [email protected])

owner_name

string

Object owner's name (i.e. John Q. User)

origin_id

string

This is the identifier of the object in the vendor system

origin_type

string

The object type (i.e. document, post, app, event)

direct_url

string

URL to the object

vendor

resource

See the vendor general resource

extra:origin_type_label

string

This field gives additional info regarding the scanned object that triggered the policy violation

extra:origin_type_label_plural

string

Similar to the origin_type_label but for a plural label

Policy

A policy is a set of rules that trigger an incident when matched.

Field ID
Type
Description

id

string

The is the Cloudlock Internal Identifier for a policy

name

string

The name of the policy. Possible values: SSN, PCI or any policy name

Matches

A Match represents an occurrence of a content pattern in an object (e.g., a file). The content pattern is defined in a policy.

Field ID
Type
Description

created_at

timestamp

When this match was detected, in UTC

text

string

text to search for in an object. Relevant for content detection criteria="Custom regex criteria"" only

ctx_after

string

Characters after the match

ctx_before

string

Characters before the match

field_name

string

Represents the field or object this match was found in

App

The app resource returns information regarding an installed application.

Field ID
Type
Description

id

string

The internal Cloudlock id for the application

name

string

The name of the application, for example: Google Drive

vendor

resource

See the vendor general resource

trust_rating

string

The community trust rating score

category

string

The app category

origin_id

string

Where the app was installed from

install_type

string

Was this installed across the domain or by a user. Possible values: domain_wide, user

is_revokable

boolean

States whether the app can be revoked

Classification

The classification resource returns information on when and how applications are classified.

Field ID
Type
Description

reason

string

The reason for the classification

updated_at

timestamp

The classification's last update time, in UTC

method

string

The method by which the classification was changed. Possible values: manual, policy

type

string

Application's classification type. Possible values: unclassified, trusted, restricted, banned

Vendor

The vendors' resource returns information on the vendor platform.

Field ID
Type
Description

name

string

The name of the vendor. For example: "google"

Scope Categories

The scope categories resource returns information on the access scopes which exist per each category.

Field ID
Type
Description

category_id

string

The category id. For example: BINFO, LACES etc¦

title

string

The categories title. For example: Basic Information

vendors

source

Access scope information broken down by the vendor platform. See the vendors general resource

The following Scope categories exist:

Scope Category
Description

FDATA

Full data access

BINFO

Basic info

LACES

Limited access to data and files

PINFO

Payment Information

INBOX

Access Inbox or contact information

Updated about a year ago

Resources Returned via API


Suggested Edits are limited on API Reference Pages

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