HomeDocumentation and Guides
Home
Documentation and Guides

Activities Endpoint

The activities endpoint returns UBA (User Behavioral Analysis) activities.

Field NameTypeDescriptionPossible Values
event_idstringThis is the Cloudlock Internal Identifier for an activity
client_ipstringThe client's IP address
event_typestringThe type of the event
created_attimestampWhen the activity took place, in UTC
operation_successfulBooleanDid the activity succeed
client_locationresourceClient location information
event_categorystringThe event category type
origin_idstringThe origin id
userresourceUser information
user_agentstring
vendorresourcePlatform information. See the vendor resource
extraresourceAdditional information related to the activity
extra.authresourceAuthentication information related to the activity
extra.auth.auth_typestringType of authentication
extra.auth.is_suspiciousBooleanIndication regarding whether the activity is flagged as being suspicious
rawresourceRaw information for the activity

Activities Filters

FilterUsageExample
event_typeFilter based on the event type i.e. login, user_settings, otherhttps://callapi.cloudlock.com/activities?event_type=user_settings
idsFilter based on the event id or a group of ids (needs url encoding)https://callapi.cloudlock.com/activities?ids=google:auth:-1595373817266362937%230,aws:CloudTrail:d891a0e2-4aaa-4cea-b237-da3d103ccbef
created_afterFilter based on the creation datehttps://callapi.cloudlock.com/activities?created_after=2016-01-01

Activities

[/activities]
List activities [GET]

  • Response 200 (application/json)
{
 "limit": 3,
 "offset": 0,
 "total": 686,
 "results": 3,
 "items": [
  {
   "event_id": "-6285966971996490902#0",
   "client_ip": "86.176.87.160",
   "event_type": "login",
   "created_at": "2018-06-23T15:18:09.000Z",
   "operation_successful": true,
   "client_location": {
    "lat": 51.8,
    "lng": -0.35,
    "country": {
     "code": "GB",
     "name": "United Kingdom"
    },
    "region": {
     "code": "F8",
     "name": "Hertford"
    },
    "city": "Harpenden"
   },
   "event_category": "auth",
   "origin_id": "-6285966971996490902",
   "user": {
    "vendor_id": "108287862377325873441",
    "user_email": "[email protected]"
   },
   "user_agent": "",
   "vendor": {
    "name": "google",
    "service": "auth"
   },
   "extra": {
    "auth": {
     "auth_type": "",
     "is_suspicious": null
    }
   },
   "raw": {
    "kind": "admin#reports#activity",
    "actor": {
     "profileId": "108287862377325873441",
     "email": "[email protected]"
    },
    "id": {
     "uniqueQualifier": "-6285966971996490902",
     "applicationName": "login",
     "customerId": "C015wxbys",
     "time": "2018-06-23T15:18:09.000Z"
    },
    "etag": "\"RU_ANZvud_qrxRGJHqK2w1PCmE4/mLe1pMbCGKexbLn4QBfOSNhifXY\"",
    "ipAddress": "86.176.87.160",
    "events": [
     {
      "type": "login",
      "name": "login_success",
      "parameters": [
       {
        "name": "login_type",
        "value": "google_password"
       }
      ]
     }
    ]
   }
  },
  {
   "event_id": "-4132259428371024344#0",
   "client_ip": "73.182.132.44",
   "event_type": "login",
   "created_at": "2018-06-23T15:16:24.000Z",
   "operation_successful": true,
   "client_location": {
    "lat": 38,
    "lng": -97,
    "country": {
     "code": "US",
     "name": "United States"
    },
    "region": {
     "code": "",
     "name": ""
    },
    "city": ""
   },
   "event_category": "auth",
   "origin_id": "-4132259428371024344",
   "user": {
    "vendor_id": "113792970216799399389",
    "user_email": "[email protected]"
   },
   "user_agent": "",
   "vendor": {
    "name": "google",
    "service": "auth"
   },
   "extra": {
    "auth": {
     "auth_type": "",
     "is_suspicious": null
    }
   },
   "raw": {
    "kind": "admin#reports#activity",
    "actor": {
     "profileId": "113792970216799399389",
     "email": "[email protected]"
    },
    "id": {
     "uniqueQualifier": "-4132259428371024344",
     "applicationName": "login",
     "customerId": "C015wxbys",
     "time": "2018-06-23T15:16:24.000Z"
    },
    "etag": "\"RU_ANZvud_qrxRGJHqK2w1PCmE4/euy8WO2wN-_3p2HpvxzOx47mxd4\"",
    "ipAddress": "73.182.132.44",
    "events": [
     {
      "type": "login",
      "name": "login_success",
      "parameters": [
       {
        "name": "login_type",
        "value": "google_password"
       }
      ]
     }
    ]
   }
  },
  {
   "event_id": "-6584956397417228660#0",
   "client_ip": "71.184.65.70",
   "event_type": "login",
   "created_at": "2018-06-23T14:37:02.000Z",
   "operation_successful": true,
   "client_location": {
    "lat": 42.3699,
    "lng": -71.2353,
    "country": {
     "code": "US",
     "name": "United States"
    },
    "region": {
     "code": "MA",
     "name": "Massachusetts"
    },
    "city": "Waltham"
   },
   "event_category": "auth",
   "origin_id": "-6584956397417228660",
   "user": {
    "vendor_id": "110344796083626325790",
    "user_email": "[email protected]"
   },
   "user_agent": "",
   "vendor": {
    "name": "google",
    "service": "auth"
   },
   "extra": {
    "auth": {
     "auth_type": "",
     "is_suspicious": null
    }
   },
   "raw": {
    "kind": "admin#reports#activity",
    "actor": {
     "profileId": "110344796083626325790",
     "email": "[email protected]"
    },
    "id": {
     "uniqueQualifier": "-6584956397417228660",
     "applicationName": "login",
     "customerId": "C015wxbys",
     "time": "2018-06-23T14:37:02.000Z"
    },
    "etag": "\"RU_ANZvud_qrxRGJHqK2w1PCmE4/lljsRbbC-u0pGaQed0g6TriZinU\"",
    "ipAddress": "71.184.65.70",
    "events": [
     {
      "type": "login",
      "name": "login_success",
      "parameters": [
       {
        "name": "login_type",
        "value": "google_password"
       }
      ]
     }
    ]
   }
  }
 ]
}