Log Object

Description of the Log Object

The Log Object provides details on how your Klaxoon services and Activities within your organization are being accessed. The Audit Log events are returned as JSON containing:

  • What action was performed.
  • Who initiated the Action.
  • Who or what was affected by this action.
  • When the action occurred.

Here's an audit event for a user joining a Klaxoon Board:

{
      "id": "xxxxxxxxxx",
      "actionDate": "2022-12-06T13:28:48.000Z",
      "action": "BOARD_JOINED_AS_PARTICIPANT",
      "author": {
        "id": "xxxxxxxxxx",
        "type": "USER",
        "email": "[email protected]",
        "companyId": "06ba74b0-a440-401d-8864-1797339d71cd",
        "companyName": "The author company",
        "ipAddress": "0.0.0.1",
        "requestId": "",
        "userAgent": "Mozilla/5.0 (X11; Linux x86_64; rv:101.0) Gecko/20100101 Firefox/101.0",
        "isExternal": false
      },
      "affected": {
        "id": "xxxxxxxxxx",
        "type": "BOARD",
        "email": "[email protected]",
        "companyId": "xxxxxxxxxx",
        "companyName": "The affected company",
        "isExternal": false
      },
      "content": {}
    }

Each entry describes the action , the author that generated the event, the affected entity and an actionDate for the date of the event.
Some audit logs have a content field showing further details on the action when available.

Actions

The action describes what triggered the log event.
Available Actions can be found in the following categories:

Author

The author group attribute provides details on who took the action. It carries the following attributes:

Autor attributesDefinition
idInternal ID of the author.
typeType of the author. It can be one of the following: USER, ORGANIZATION or COMPANY
emailThe email address of the author. If the author does not belong to your organization this field will be anonymized.
companyNameName of the company the author author belongs to.
ipAddressIP address of the original HTTP Request (optional).
requestIdInternal ID of the original HTTP request of the author (optional).
userAgentUser agent of the original HTTP Request (optional).
isExternalBoolean set to True if the author does not belongs to your organization.

Affected

The affected group attribute provides details on who or what what affected by the action. It carries the following attributes:

Affected attributesDefinition
idInternal ID of the affected entity.
typeType of the affected entity. Any Klaxoon entity can be an affected. It can be one of the following: USER, ORGANIZATION, COMPANY, BOARD, QUESTION, SESSION, QUIZ, MEMO, ADVENTURE, ARTICLE, MISSION, NETWORK, SURVEY.
emailThe email address of the affected entity if applicable. If the affected does not belong to your organization this field will be anonymized.
companyNameName of the company the affected entity belongs to.
isExternalBoolean set to True if the affected entity does not belongs to your organization.

Date

The actionDate attribute provides the date and time when the action occurred. All dates are UTC and format as follow '2022-06-20T20:20:20'.

Content

The content attribute is available to provide additional details of the action (for example the value of a parameter before and after the action or the reason why the action event was triggered).

This does not apply to all actions and the content field can be empty.

Full list of available Actions

Organisation events

Action TypeDefinition
ORGANIZATION_AUDIT_LOGS_EXPORTEDOrganization audit logs have been exported
ORGANIZATION_AVATAR_UPDATEDOrganization avatar has been updated
ORGANIZATION_BRANDING_COLOR_UPDATEDOrganization branding color has been updated
ORGANIZATION_BRANDING_LOGO_UPDATEDOrganization logo has been updated
ORGANIZATION_CREATEDOrganization has been created
ORGANIZATION_DELETEDOrganization has been deleted
ORGANIZATION_FORCE_SSO_DISABLEDOrganization Force SSO feature has been disabled
ORGANIZATION_FORCE_SSO_ENABLEDOrganization Force SSO feature has been enabled
ORGANIZATION_INVITATION_SENTOrganization Invitation has been sent
ORGANIZATION_LEAVE_DISABLEDOrganization User Allowed to Leave feature has been disabled
ORGANIZATION_LEAVE_ENABLEDOrganization User Allowed to Leave feature has been enabled
ORGANIZATION_NAME_UPDATEDOrganization name has been updated
ORGANIZATION_OFFER_UPDATEDOrganization Offer has been updated
ORGANIZATION_PLAN_UPDATEDOrganization Plan has been updated
ORGANIZATION_SCIM_DISABLEDOrganization SCIM feature has been disabled
ORGANIZATION_SCIM_ENABLEDOrganization SCIM feature has been enabled
ORGANIZATION_SSO_ADDEDSSO provider has been associated to the Organization
ORGANIZATION_SSO_REMOVEDOrganization SSO provider has been removed
ORGANIZATION_LOGO_UPDATEDOrganization logo has been updated
ORGANIZATION_USER_LIST_EXPORTEDOrganization user list has been exported
COMPANY_ANONYMIZE_ACTIVITY_REPORTS_DISABLEDCompany Anonymize Users feature has been disabled
COMPANY_ANONYMIZE_ACTIVITY_REPORTS_ENABLEDCompany Anonymize Users feature has been enabled
COMPANY_AUDIT_LOGS_EXPORTEDCompany audit logs have been exported
COMPANY_CREATEDCompany has been created
COMPANY_DELETEDCompany has been deleted
COMPANY_IDENTIFY_EXTERNAL_USER_DISABLEDCompany Identify External Users feature has been disabled
COMPANY_IDENTIFY_EXTERNAL_USER_ENABLEDCompany Identify External Users feature has been enabled
COMPANY_LOGO_UPDATEDCompany logo has been updated
COMPANY_NAME_UPDATEDCompany name has been updated
COMPANY_ORGANIZATION_ADDEDOrganization has been added to the Company
COMPANY_ORGANIZATION_REMOVEDOrganization has been removed from the Company
COMPANY_USER_LIST_EXPORTEDCompany user list has been exported
COMPANY_VERIFY_USER_DISABLEDCompany Verify Users feature has been disabled
COMPANY_VERIFY_USER_ENABLEDCompany Verify Users feature has been enabled
ORGANIZATION_LMS_ADDEDLearning management system has been associated to the Organization
ORGANIZATION_LMS_REMOVEDOrganization Learning management system has been removed

Users Management events

Action TypeDefinition
ACTIVE_USER_LICENSE_REMOVEDActive user license has been removed
ACTIVITY_OWNERSHIP_TRANSFERREDActivity ownership has been transferred
ORGANIZATION_USER_IMPORT_CSVOrganization CSV import has been performed
ORGANIZATION_USER_UPDATE_CSVOrganization CSV users update has been performed
USER_ACTIVATEDUser has been activated
USER_AVATAR_UPDATEDUser avatar has been updated
USER_CREATEDUser has been created
USER_DEACTIVATEDUser has been deactivated
USER_DELETEDUser has been deleted
USER_EMAIL_CONFIRMEDUser email address has been confirmed
USER_EULA_ACCEPTEDUser has accepted EULA
USER_FIRSTNAME_UPDATEDUser first name has been updated
USER_IDENTITY_VERIFIEDUser Verified by Company flag has been updated
USER_INVITATION_SENTUser has been invited
USER_LABELS_UPDATEDUser labels have been updated
USER_LANG_UPDATEDUser language has been updated
USER_LASTNAME_UPDATEDUser last name has been updated
USER_LICENSE_UPDATEDUser license has been updated
USER_ORGANIZATION_JOINEDUser has joined an Organization
USER_ORGANIZATION_LEFTUser has left her/his Organization
USER_PASSWORD_CHANGEDUser password changed
USER_PASSWORD_RESET_EMAIL_SENTUser password reset email has been sent
USER_PHONE_UPDATEDUser phone number has been updated
USER_ROLE_UPDATEDUser role has been updated
USER_SIGNED_OUTUser has signed out
USER_SIGN_IN_FAILEDUser sign in failed
USER_SIGN_IN_SUCCEEDEDUser has signed in successfully
USER_DELETE_CONTENT_REQUESTEDA request to delete user content has been sent
USER_HOST_PRIVILEGE_GRANTEDUser has been granted with the role host
USER_LICENSE_REQUEST_ACCEPTEDUser license request has been accepted
USER_LICENSE_REQUEST_IGNOREDUser license request has been ignored

User Apps Management events

Action TypeDefinition
USER_APP_CREATEDUser app has been created
USER_APP_UPDATEDUser app has been updated
USER_APP_DELETEDUser app has been deleted

Access restriction events

Action TypeDefinition
PLATFORM_ACCESS_RESTRICTEDUser access to the Platform has been blocked
ACTIVITY_ACCESS_GRANTEDAccess Filtering Configuration is unavailable. User access to the Activity has been granted
ACTIVITY_ACCESS_RESTRICTEDUser access to the Activity has been blocked
ORGANIZATION_INVITATION_ACCESS_RESTRICTEDUser access to the Organization's Invitation has been blocked
ACTIVITY_USER_BLOCKEDActivity user has been blocked
ACTIVITY_USER_UNBLOCKEDActivity user has been unblocked
ACTIVITY_ACCESSRIGHT_SET_ORGANIZATION