Policies Endpoint

The policies endpoint returns all of the organizations configured policies.

Field Name
Type
Description
Example

id

string

This is the Cloudlock Internal Identifier for a policy

G8qz0vb49V

name

string

The name of the policy

PCI - Alert

state

string

Indicates if the policy is active or inactive

Active, Inactive

description

string

Description of the policy

Apps whose authorized access scopes present potential security risks

created_at

timestamp

Policy creation time, in UTC

2018-03-19T09:00:17.602482+00:00

updated_at

timestamp

Policy updated time, in UTC

2018-03-19T09:00:17.602482+00:00

severity

string

The severity assigned to incidents of this policy

CRITICAL,WARNING,INFO,ALERT

List All Policies

[/policies{?state}]
List all of an organizations policies [GET]

  • Parameters
  • state (optional, options, active )
Response 200 (application/json)
[
   {
    "id": "nLzJQyXxR5",
    "name": "Cyber Bullying K12",
    "description": "",
    "state": "ACTIVE",
    "created_at": "2018-06-01T14:31:19.989390+00:00",
    "updated_at": null
    "severity": "ALERT"
   },
   {
    "id": "rRzEJP039N",
    "name": "Explicit Content",
    "description": "",
    "state": "ACTIVE",
    "created_at": "2018-05-22T16:39:35.058164+00:00",
    "updated_at": null
    "severity": "WARNING"
   },
]

Policies Endpoint


Suggested Edits are limited on API Reference Pages

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