Audit Log Actions

https://api.losant.com/orgs/ORG_ID/audit-logs/AUDIT_LOG_ID

Below are the various requests that can be performed against the Audit Log resource, as well as the expected parameters and the potential responses.

Get

Retrieves information on an audit log

Method And Url

GET https://api.losant.com/orgs/ORG_ID/audit-logs/AUDIT_LOG_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.read, all.User, all.User.read, auditLog.*, or auditLog.get.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8
AUDIT_LOG_ID	ID associated with the audit log	57955788124b37010084c053

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/orgs/ORG_ID/audit-logs/AUDIT_LOG_ID

Successful Responses

Code	Type	Description
200	Audit Log	Audit log information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if audit log was not found

Schemas

Audit Log

Schema for a single Audit Log entry

Audit Log Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 20 keys
▶
id:{} 2 keys
▶
auditLogId:{} 2 keys
▶
creationDate:{} 2 keys
▶
orgId:{} 2 keys
▶
primaryTargetId:{} 2 keys
▶
primaryTargetType:{} 2 keys
▶
primaryTargetName:{} 2 keys
▶
secondaryTargetId:{} 2 keys
▶
secondaryTargetType:{} 2 keys
▶
secondaryTargetName:{} 2 keys
▶
actorId:{} 2 keys
▶
actorType:{} 2 keys
▶
actorName:{} 2 keys
▶
requestResource:{} 2 keys
▶
requestAction:{} 2 keys
▶
requestQueryParams:{} 1 key
▶
requestBody:{} 1 key
▶
requestPathParams:{} 1 key
▶
responseBody:{} 1 key
▶
responseStatus:{} 3 keys

Audit Log Example

▶
root:{} 17 keys
id:"586e9d5151265cb9d72f6ec6"
auditLogId:"586e9d5151265cb9d72f6ec6"
creationDate:"2016-06-13T04:00:00.000Z"
orgId:"575ed6e87ae143cd83dc4aa8"
primaryTargetId:"575ec8687ae143cd83dc4a97"
primaryTargetType:"Application"
primaryTargetName:"My Application"
actorId:"575ed70c7ae143cd83dc4aa9"
actorType:"User"
actorName:"actor@example.com"
requestResource:"application"
requestAction:"delete"
requestQueryParams:{} 0 keys
requestBody:{} 0 keys
▶
requestPathParams:{} 1 key
▶
responseBody:{} 1 key
responseStatus:200

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"