Access Logging

Your audit data.

AccessLogEntry Object Attributes

All requests made to your Organization Account are recorded for audit purposes. This enables you to perform security audits, provides insights into API usage, helps troubleshoot issues, and detects potential abuse. You can query this data by using Elastic Search Query DSL, see the AccessLogEntries REST API documentation for details.

Name

Type

Description

organizationAccountID

String

The Organization Account ID

serviceID

String

The REST API service id, 'genericobjects', 'useraccounts', etc.

serviceVersion

String

The REST API service version

operationID

String

he REST API operation id: 'create', 'retrieve', 'update', 'delete', etc.

correlationID

String

The correlation id.

principalID

String

The user account id or service account id used in the request. This is extracted from the access token.

sessionID

String

The client app session id if one was provided in the request

remoteAddr

String

The IP Address where the request originated from.

userAgent

String

The request User Agent

requestDateTime

Date-Time

date-time string at UTC, format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard. Example: 2007-12-03T10:15:30Z

accessPoint

String

What Access Point was used, EU, US, etc.

environment

String

What environment this request was pointing to, PROD, TEST

requestURL

String

The request's URL

requestBody

String

The request's Body

httpMethod

String

The request's method, GET, POST, PUT, DELETE, etc.

responseDateTime

Date-Time

date-time string at UTC, format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard. Example: 2007-12-03T10:15:30Z

responseCode

Integer

The response's HTTP Status code

responseTimeNanoseconds

Float

What was the response's performance in nanoseconds at the datacenter edge. Excludes the network lag from client app to the datacenter and back.

objectsAccessGranted

Array of ObjectInfo

Info for the Objects we granted access to

objectsAccessDenied

Array of ObjectInfo

Info for the Objects we denied access to

ObjectInfo Object Attributes

Details about the object for which access was granted or denied. In a mutation operation (CRUD), a single object is affected, and it's information is included in the AccessLogEntry, so here it will be null. In a list (or query) operation, multiple objects may be requested, with access granted to some and possibly denied to others. You will find that information here.

Name

Type

Description

objectID

String

The Object's ID

objectType

String

The Object Type

namespace

String

The Object's namespace

objectVersion

String

The Object's version

deleted

Boolean

If the Object is deleted