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:
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:
The author group attribute provides details on who took the action. It carries the following attributes:
Autor attributes
Definition
id
Internal ID of the author.
type
Type of the author. It can be one of the following: USER, ORGANIZATION or COMPANY
email
The email address of the author. If the author does not belong to your organization this field will be anonymized.
companyName
Name of the company the author author belongs to.
ipAddress
IP address of the original HTTP Request (optional).
requestId
Internal ID of the original HTTP request of the author (optional).
userAgent
User agent of the original HTTP Request (optional).
isExternal
Boolean 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 attributes
Definition
id
Internal ID of the affected entity.
type
Type 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.
email
The email address of the affected entity if applicable. If the affected does not belong to your organization this field will be anonymized.
companyName
Name of the company the affected entity belongs to.
isExternal
Boolean 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 Type
Definition
ORGANIZATION_AVATAR_UPDATED
Organization avatar has been updated
ORGANIZATION_BRANDING_COLOR_UPDATED
Organization branding color has been updated
ORGANIZATION_BRANDING_LOGO_UPDATED
Organization logo has been updated
ORGANIZATION_CREATED
Organization has been created
ORGANIZATION_DELETED
Organization has been deleted
ORGANIZATION_FORCE_SSO_DISABLED
Organization Force SSO feature has been disabled
ORGANIZATION_FORCE_SSO_ENABLED
Organization Force SSO feature has been enabled
ORGANIZATION_INVITATION_SENT
Organization Invitation has been sent
ORGANIZATION_LEAVE_DISABLED
Organization User Allowed to Leave feature has been disabled
ORGANIZATION_LEAVE_ENABLED
Organization User Allowed to Leave feature has been enabled
ORGANIZATION_NAME_UPDATED
Organization name has been updated
ORGANIZATION_OFFER_UPDATED
Organization Offer has been updated
ORGANIZATION_PLAN_UPDATED
Organization Plan has been updated
ORGANIZATION_SCIM_DISABLED
Organization SCIM feature has been disabled
ORGANIZATION_SCIM_ENABLED
Organization SCIM feature has been enabled
ORGANIZATION_SSO_ADDED
SSO provider has been associated to the Organization
ORGANIZATION_SSO_REMOVED
Organization SSO provider has been removed
COMPANY_ANONYMIZE_ACTIVITY_REPORTS_DISABLED
Company Anonymize Users feature has been disabled
COMPANY_ANONYMIZE_ACTIVITY_REPORTS_ENABLED
Company Anonymize Users feature has been enabled
COMPANY_CREATED
Company has been created
COMPANY_DELETED
Company has been deleted
COMPANY_IDENTIFY_EXTERNAL_USER_DISABLED
Company Identify External Users feature has been disabled
COMPANY_IDENTIFY_EXTERNAL_USER_ENABLED
Company Identify External Users feature has been enabled
COMPANY_LOGO_UPDATED
Company logo has been updated
COMPANY_NAME_UPDATED
Company name has been updated
COMPANY_ORGANIZATION_ADDED
Organization has been added to the Company
COMPANY_ORGANIZATION_REMOVED
Organization has been removed from the Company
COMPANY_VERIFY_USER_DISABLED
Company Verify Users feature has been disabled
COMPANY_VERIFY_USER_ENABLED
Company Verify Users feature has been enabled
Users Management events
Action Type
Definition
USER_ACTIVATED
User has been activated
USER_AVATAR_UPDATED
User avatar has been updated
USER_CREATED
User has been created
USER_DEACTIVATED
User has been deactivated
USER_DELETED
User has been deleted
USER_EMAIL_CONFIRMED
User email address has been confirmed
USER_EULA_ACCEPTED
User has accepted EULA
USER_FIRSTNAME_UPDATED
User first name has been updated
USER_IDENTITY_VERIFIED
User Verified by Company flag has been updated
USER_INVITATION_SENT
User has been invited
USER_LANG_UPDATED
User language has been updated
USER_LASTNAME_UPDATED
User last name has been updated
USER_LICENSE_UPDATED
User license has been updated
USER_ORGANIZATION_JOINED
User has joined an Organization
USER_ORGANIZATION_LEFT
User has left her/his Organization
USER_PASSWORD_CHANGED
User password changed
USER_PASSWORD_RESET_EMAIL_SENT
User password reset email has been sent
USER_PHONE_UPDATED
User phone number has been updated
USER_ROLE_UPDATED
User role has been updated
USER_SIGNED_OUT
User has signed out
USER_SIGN_IN_FAILED
User sign in failed
USER_SIGN_IN_SUCCEEDED
User has signed in successfully
ACTIVITY_OWNERSHIP_TRANSFERRED
Activity ownership has been transferred
Access restriction events
Action Type
Definition
PLATFORM_ACCESS_RESTRICTED
User access to the Platform has been blocked
ACTIVITY_ACCESS_GRANTED
Access Filtering Configuration is unavailable. User access to the Activity has been granted
ACTIVITY_ACCESS_RESTRICTED
User access to the Activity has been blocked
ORGANIZATION_INVITATION_ACCESS_RESTRICTED
User access to the Organization's Invitation has been blocked