Auditing Platform Events

Audit events are available only per request and may be subject to an additional charge. For more information, contact your Account Manager.

For audit purposes, you can get a list of events that have occurred on the GoodData platform. To do so, use the audit events API.

A domain admin can list audit events for the whole domain and for any user in their domain. A user can list only their own events.

Event Properties

An event has the following properties:

  • id is the unique ID of the event.
  • userLogin is the login name (email address) of the user who performed the event.
  • userIp is the IP address of the user who performed the event.
  • success indicates whether the event was successful (true/false).
  • type is the event type.
  • occurred is the timestamp when the event occurred.
  • recorded is the timestamp when the event was recorded by the system.
  • (For some event types only) params is a a string/string map of additional context information.
  • (For some event types only) links is a string/string map of the affected resources.

Event Types

An event can be one of the following types:

TypeDescriptionAdditional parameters in 'params'Affected resources in 'links'
CONNECTION

A connection was established.

For example, connecting to the GoodData platform using a Data Warehouse proxy triggers this event.


component is the component that the connection was established to

connection_id is the ID of the connection

DATA_ACCESSA user accessed project data.

type is the resource used for accessing data (elements, validElements, dataResult, datawarehouse)

(For type=datawarehouse only) connection_id is the unique ID of the connection with the Data Warehouse instance.

(For type=datawarehouse only) execution_id is the unique ID of each execution. More than one DATAWAREHOUSE_DATA_ACCESS event with different execution_id's in one connection can be present.

project is the URI of the project whose data was accessed.

(For type=datawarehouse only) datawarehouse is the URI of the Data Warehouse instance the user tried to access data on.

DATA_EXPORT

A project dashboard was exported to PDF.

A project report was exported to PDF, PNG, XLSX, CSV, or raw CSV.

format is the export format (such as, application/pdf for PDF, application/raw for raw CSV, and so on).

project is the URI of the project where the exported dashboard or report belongs to.

(For exported dashboards only) dashboard is the URI of the exported dashboard.

DATAWAREHOUSE_LOGOUT

A user logged out from the Data Warehouse instance.

connection_id is the unique ID of the connection with the Data Warehouse instance.

timeout identifies whether the logout was forced by the proxy timeout (true/false).

datawarehouse is the URI of the Data Warehouse instance the user logged out from.

DATAWAREHOUSE_USER_ADD

A user was added to the Data Warehouse instance.


datawarehouse is the URI of the Data Warehouse instance the user was added to.

profile is the URI of the user's profile who was added to the Data Warehouse instance.

DATAWAREHOUSE_USER_REMOVEA user was removed from the Data Warehouse instance.

datawarehouse is the URI of the Data Warehouse instance the user was removed from.

profile is the URI of the user's profile who was removed from the Data Warehouse instance.

ETL_ADD_MANUAL_EXECUTE

A user manually executed Automated Data Distribution (ADD) either by manually executing an ADD ETL schedule or by executing an ADD ETL process.


project is the URI of the project where the executed ADD ETL process is placed.

process is the URI of the executed ADD ETL process.

execution is the URI of the ADD ETL process execution.

instance is the URI of the Data Warehouse instance where ADD runs.

ETL_PROCESS_CREATEA user created an ETL process.

project is the URI of the project where the ETL process is created.

process is the URI of the created ETL process.

ETL_PROCESS_DELETEA user deleted an ETL process.

project is the URI of the project where the ETL process is deleted from.

process is the URI of the deleted ETL process.

ETL_PROCESS_MANUAL_
EXECUTE
A user manually executed the ETL process.

project is the URI of the project where the executed ETL process is placed.

process is the URI of the executed ETL process.

execution is the URI of the ETL process execution.

ETL_PROCESS_UPDATEA user updated an ETL process.

project is the URI of the project where the ETL process is updated.

process is the URI of the updated ETL process.

ETL_SCHEDULE_CHANGEA user changed the ETL schedule.

project is the URI of the project where the changed ETL schedule is placed.

process is the URI of the ETL process that contains the changed ETL schedule.

schedule is the URI of the changed ETL schedule.

ETL_SCHEDULE_MANUAL_
EXECUTE
A user manually executed the ETL schedule.

project is the URI of the project where the executed ETL schedule is placed.

process is the URI of the ETL process that contains the executed ETL schedule.

schedule is the URI of the executed ETL schedule.

execution is the URI of the ETL schedule execution.

INVITATION_RESENTAn invitation to join a project was re-sent to a user.invited is the email of the invited user.

project is the URI of the project to which the user was invited.

role is the URI of the role under which the user was invited to the project (see User Roles).

INVITATION_SENTAn invitation to join a project was sent to a user.invited is the email of the invited user.

project is the URI of the project to which the user was invited.

role is the URI of the role under which the user was invited to the project (see User Roles).

LOGINA user logged in to the GoodData platform.

loginType is the type of login (basic authentication login, username/password login, SSO, SFTP, and so on).

component is the component that the user logged in to (web app, WebDAV, Data Warehouse).

(For loginType=sftp only) project is the URI of the project to which the user logged in via SFTP.

PROJECT_USER_ADDA user was added to the project.

project is the URI of the project to which the user was added.

profile is the URI of the user's profile who was added.

PROJECT_USER_STATUS_CHANGEThe status in a user's profile changed.status is the changed status (ENABLED/DISABLED) of the user.

project is the URI of the project in which the user's status changed.

profile is the URI of the user's profile.

SST_CREATEThe SST was created and saved for a user.

verify_level specifies how the SST should be returned back to the client, in an HTTP cookie or a custom HTTP header (see API for logging in to the GoodData platform).

profile is the URI of the user's profile for whom the SST was created.

STANDARD_LOGOUTA user logged out.

USER_IP_WHITELIST_CHANGE

The IP Whitelisting setting in a user's profile changed.


profile is the URI of the user's profile.

USER_PASSWORD_CHANGE A user's password changed, created or reset.

login - login of the user.

domain - domain of the user.


USER_PROFILE_CHANGEA user's profile changed.

profile is the URI of the user's profile.

USER_PROVISIONED_BY_SAMLThe user is provisioned by SAML login (by SAML provider). This event covers all provisioning steps - user provisioning, user in project provisioning, user groups provisioning. If one of the mentioned steps fails, the event is considered as unsuccessful.
  • saml_provider - provider that did the provisioning.
  • project_id - ID of the project where the user was provisioned (present if dataproduct_id + client_id was not specified).
  • dataproduct_id + client_id - dataproduct and client ID where the user was provisioned (optional).
  • project_role - user role in provisioned project (if not specified = default role assigned).
  • user_groups - provisioned user groups of the user (if not specified = no user groups provisioned).