Log Object

πŸ“˜

Note

Audit log endpoints are not being deprecated. These endpoints remain the same and use v1 in the endpoint URLs, as documented.

The audit logs feature allows Company Admins to track changes made within the all company teams. They come in extremely useful when you need to troubleshoot a problem or to get a detailed report of important events (e.g. changes to the global security settings, invitations of new users, new boards created, etc.).

How to make it work:

  1. Create an Application and set it to use 'audit-logs' scope
  2. Install this Application on any team in the organisation. Important: the installer should be Company Admin in this organisation.
  3. Use access_token you received from installation to retrieve audit logs via endpoint below.

❗️

App that uses audit logs must be installed by the Company Admin.

{
  "type": "list",
  "limit": 10,
  "offset": 0,
  "size": 9158,
  "nextLink": "http://api.miro.com/v1/audit/logs?createdAfter=2018-10-10&createdBefore=2018-10-20&limit=10&offset=10",
  "prevLink": null,
  "data": [
    {
      "type": "event",
      "event": "board_opened",
      "details": {
        "role": "OWNER"
      },
      "createdAt": "2018-10-19T23:59:45Z",
      "createdBy": {
        "type": "user",
        "name": "Test",
        "id": "3074457346235995512",
      },
      "object": {
        "id": "3074457346235995523",
        "name": "BoardName"
      },
      "context": {
        "organization": {
          "type": "organization",
          "name": "CompanyName",
          "id": "3074457345821140123"
        },
        "team": {
          "type": "team",
          "name": "TeamName",
          "id": "3074457345710755694"
        },
        "ip": "10.10.10.10"
      },
      "id": "450256789"
    },
    //...
  ]
}

🚧

account field is deprecated, please do not use it.

createdBy is user who triggered the event.

object specifies which object was affected by the event.

context shows connection of the event to specific Organization and Team, with the appropriate ID.

Some audit events have details field showing new value of some parameters.
This field is fixed for each event-type.

event specifies the type of event occurred, based on the following list:

  • access_requests_management_flow_changed
  • access_requests_management_service_desk_url_changed
  • access_requests_management_servicenow_email_changed
  • account_board_copy_access_level_limitation_changed
  • account_change_list_whitelisted_domains
  • account_created
  • account_default_board_copy_access_level_changed
  • account_default_board_sharing_settings_changed
  • account_default_project_sharing_settings_changed
  • account_deleted
  • account_disable_sharing_ext_users_of_notwhitelisted_domains
  • account_disable_whitelisted_domains
  • account_discovery_mode_changed
  • account_editing_via_public_link_disabled
  • account_editing_via_public_link_enabled
  • account_enable_sharing_ext_users_of_notwhitelisted_domains
  • account_enable_whitelisted_domains
  • account_external_collaborators_disabled
  • account_external_collaborators_enabled
  • account_integration_settings_changed
  • account_invitation_settings_changed
  • account_logo_changed
  • account_logo_removed
  • account_move_boards_disabled
  • account_move_boards_enabled
  • account_name_changed
  • account_sharing_via_public_link_disabled
  • account_sharing_via_public_link_enabled
  • account_sharing_with_account_disabled
  • account_sharing_with_account_enabled
  • account_sharing_with_organization_disabled
  • account_sharing_with_organization_enabled
  • account_sign_up_domain_list_changed
  • account_sign_up_mode_changed
  • app_authorized
  • app_permitted
  • app_prohibited
  • app_unauthorized
  • app_uninstalled
  • board_accessed
  • board_account_sharing_disabled
  • board_account_sharing_enabled
  • board_account_sharing_permission_changed
  • board_added_to_project
  • board_copy_access_level_changed
  • board_cover_changed
  • board_created
  • board_deleted
  • board_description_changed
  • board_moved_from_account
  • board_moved_to_account
  • board_name_changed
  • board_opened
  • board_organization_sharing_disabled
  • board_organization_sharing_enabled
  • board_organization_sharing_permission_changed
  • board_owner_changed
  • board_public_link_disabled
  • board_public_link_enabled
  • board_public_link_password_changed
  • board_public_link_password_disabled
  • board_public_link_password_enabled
  • board_public_link_permission_changed
  • board_removed_from_project
  • board_restored
  • board_shared_for_commenting
  • board_shared_for_editing
  • board_shared_for_viewing
  • board_slack_channel_changed
  • board_slack_disabled
  • board_slack_enabled
  • board_unshared
  • organization_account_visibility_restriction_disabled
  • organization_account_visibility_restriction_enabled
  • organization_deleted
  • organization_editing_via_public_link_disabled
  • organization_editing_via_public_link_enabled
  • organization_enforce_password_protection_disabled
  • organization_enforce_password_protection_enabled
  • organization_logo_changed
  • organization_logo_removed
  • organization_name_changed
  • organization_scim_disabled
  • organization_scim_enabled
  • organization_scim_generated
  • organization_scim_notification_disabled
  • organization_scim_notification_enabled
  • organization_session_idle_timeout_disabled
  • organization_session_idle_timeout_enabled
  • organization_sharing_via_public_link_disabled
  • organization_sharing_via_public_link_enabled
  • organization_sharing_with_external_collaborators_disabled
  • organization_sharing_with_external_collaborators_enabled
  • organization_sso_disabled
  • organization_sso_enabled
  • organization_sso_settings_changed
  • organization_whitelisted_domains_disabled
  • organization_whitelisted_domains_enabled
  • organization_whitelisted_domains_list_changed
  • project_account_sharing_disabled
  • project_account_sharing_enabled
  • project_created
  • project_deleted
  • project_owner_changed
  • project_renamed
  • project_shared_comment
  • project_shared_edit
  • project_shared_view
  • project_unshared
  • sign_in_failed
  • sign_in_succeeded
  • sign_out_succeeded
  • template_created
  • template_deleted
  • template_opened
  • template_owner_changed
  • template_restored
  • user_confirmed_new_email_address
  • user_converted_to_org_external
  • user_deactivated
  • user_demoted_from_account_admin
  • user_demoted_from_org_admin
  • user_invitation_to_account_removed
  • user_invited_to_account
  • user_joined_to_account
  • user_joined_to_organization
  • user_license_converted_to_full
  • user_license_converted_to_occasional
  • user_locked
  • user_profile_changed
  • user_promoted_to_account_admin
  • user_promoted_to_org_admin
  • user_reactivated
  • user_removed_from_account
  • user_removed_from_organization
  • user_requested_email_address_change
  • user_unlocked