Skip to content

Commit ced57c8

Browse files
committed
Reapply audit log enhancements
1 parent 93519e5 commit ced57c8

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

source/hub/admin.rst

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,37 +68,39 @@ The following events are logged:
6868
Device
6969
"""""""
7070

71-
- **Register Device** - A user :ref:`registered a new device <hub/access-vault/unlocking-a-vault/add-device>`.
71+
- **Register Device** - A user :ref:`registered a new device <hub/access-vault/unlocking-a-vault/add-device>`. This can be e.g. a Cryptomator app (desktop/mobile) to unlock a vault or a web browser to access Cryptomator Hub.
7272
- **Remove Device** – A user :ref:`removed a device <hub/your-account/profile/authorized-devices>`.
7373

7474
Web of Trust
7575
""""""""""""
7676

7777
- **Signed Identity** – A user :ref:`signed the identity of another user <hub/vault-management/wot>`.
78-
- **Update Wot Setting** – A user updated :ref:`Web-of-Trust settings<hub/vault-management/wot>`.
78+
- **Update Wot Setting** – A user updated :ref:`Web-of-Trust settings<hub/vault-management/wot>`, e.g. the ``wot_max_depth``.
7979

8080
Vault
8181
""""""
8282

83-
- **Add Vault Member** – A vault owner :ref:`added a member to a vault <hub/vault-management/add-user>`.
83+
- **Add Vault Member** – A vault owner :ref:`added a member to a vault <hub/vault-management/add-user>`. This only adds the member but does not derive the vault key for the new member.
8484
- **Create Vault** – A user :ref:`created a vault <hub/vault-management/create-vault>`.
8585
- **Grant Vault Access** – A user :ref:`derived the vault key for the new member <hub/vault-management/updating-permission>`.
86-
- **Retrieve Vault Key** – A user retrieved a vault key.
86+
- **Retrieve Vault Key** – A user retrieved a vault key. This happens when a user :ref:`unlocks a vault <hub/access-vault/unlocking-a-vault>` but also e.g. when a owner manages the vault. The IP address and device information are optional for legacy reasons.
8787
- **Remove Vault Member** – A vault owner removed a member from a vault.
88-
- **Update Vault Member** – A vault owner :ref:`changed a member’s role <hub/vault-management/change-ownership>`.
89-
- **Update Vault** – A vault owner :ref:`updated the vault metadata <hub/vault-management/edit-vault-metadata>`.
88+
- **Update Vault Member** – A vault owner :ref:`changed a member’s role <hub/vault-management/change-ownership>` (owner or user).
89+
- **Update Vault** – A vault owner :ref:`updated the vault metadata <hub/vault-management/edit-vault-metadata>`. This includes the vault name or description.
9090

9191
Account
9292
""""""""
9393

94-
- **Account Key Changed** – A user :ref:`re-generated the account key <hub/your-account/profile/regenerate-account-key>`.
95-
- **Reset User Account** – A user :ref:`reset its account <hub/your-account/reset-account>`.
96-
- **User Keys Change** – A user changed its keys.
94+
- **Account Key Changed** – A user :ref:`re-generated the account key <hub/your-account/profile/regenerate-account-key>`. This also logs ``User Keys Change`` because changing the account key also changes parts of the user keys.
95+
- **Reset User Account** – A user :ref:`resetted it's account <hub/your-account/reset-account>`.
96+
- **User Keys Change** – A user changed it's keys. This happens when e.g. the user :ref:`finished the account setup <hub/your-account/setup>` or when the ``Account Key Changed``.
9797

9898
Legacy
9999
""""""
100100

101-
- **Claim Vault Ownership** – A user claimed vault ownership.
101+
- **Claim Vault Ownership** – A user claimed vault ownership. This event is logged when a vault created with hub pre 1.3.0 is claimed by the vault creator using the `Vault Admin Password`.
102+
103+
.. _hub/admin/audit-logs/table-view:
102104

103105
Audit Log Table View
104106
^^^^^^^^^^^^^^^^^^^^
@@ -112,6 +114,8 @@ The logs are displayed in a structured table containing the following columns:
112114
.. image:: ../img/hub/auditlogs-overview.png
113115
:alt: Audit Logs Table View
114116

117+
.. _hub/admin/audit-logs/filters:
118+
115119
Filtering Audit Logs
116120
^^^^^^^^^^^^^^^^^^^^
117121

0 commit comments

Comments
 (0)