Skip to content

Commit c7519da

Browse files
committed
Supplement hub audit logs documentation
1 parent d8e83be commit c7519da

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

source/hub/audit-logs.rst

+28-17
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,38 @@ The following events are logged:
1818

1919
Device
2020
^^^^^^
21-
- **Register Device** – A device has been registered. :ref:`Read more <hub/access-vault/unlocking-a-vault/add-device>`
22-
- **Remove Device** – A device has been removed.
23-
WoT
24-
^^^
25-
- **Signed Identity** – A Web-of-Trust identity has been signed. :ref:`Read more <hub/vault-management/wot>`
26-
- **Update Wot Setting** – A Web-of-Trust setting has been updated.
21+
22+
- **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.
23+
- **Remove Device** – A user :ref:`removed a device <hub/your-account/profile/authorized-devices>`.
24+
25+
Web of Trust
26+
^^^^^^^^^^^^
27+
28+
- **Signed Identity** – A user :ref:`signed the identity of another user <hub/vault-management/wot>`.
29+
- **Update Wot Setting** – A user updated :ref:`Web-of-Trust settings<hub/vault-management/wot>`, e.g. the ``wot_max_depth``.
30+
2731
Vault
2832
^^^^^
29-
- **Add Vault Member** – A member has been added to a vault. :ref:`Read more <hub/vault-management/add-user>`
30-
- **Create Vault** – A vault has been created. :ref:`Read more <hub/vault-management/create-vault>`
31-
- **Claim Vault Ownership** – Vault ownership has been claimed.
32-
- **Grant Vault Access** – Access to a vault has been granted. :ref:`Read more <hub/vault-management/updating-permission>`
33-
- **Retrieve Vault Key** – A vault key has been retrieved.
34-
- **Remove Vault Member** – A member has been removed from a vault.
35-
- **Update Vault Member** – A vault member’s role (owner VS user) have been updated. :ref:`Read more <hub/vault-management/change-ownership>`
36-
- **Update Vault** – A vault has been updated. :ref:`Read more <hub/vault-management/edit-vault-metadata>`
33+
34+
- **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.
35+
- **Create Vault** – A user :ref:`created a vault <hub/vault-management/create-vault>`.
36+
- **Grant Vault Access** – A user :ref:`derived the vault key for the new member <hub/vault-management/updating-permission>`.
37+
- **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.
38+
- **Remove Vault Member** – A vault owner removed a member from a vault.
39+
- **Update Vault Member** – A vault owner :ref:`changed a member’s role <hub/vault-management/change-ownership>` (owner or user).
40+
- **Update Vault** – A vault owner :ref:`updated the vault metadata <hub/vault-management/edit-vault-metadata>`. This includes the vault name or description.
41+
3742
Account
3843
^^^^^^^
39-
- **Account Key Changed** – A user’s account key has been changed. :ref:`Read more <hub/your-account/profile/regenerate-account-key>`
40-
- **Reset User Account** – A user account has been reset. :ref:`Read more <hub/your-account/reset-account>`
41-
- **User Keys Change** – User keys have been changed. :ref:`Read more <hub/your-account/account-key>`
44+
45+
- **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.
46+
- **Reset User Account** – A user :ref:`resetted it's account <hub/your-account/reset-account>`.
47+
- **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``.
48+
49+
Legacy
50+
^^^^^^
51+
52+
- **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`.
4253

4354
.. _hub/audit-logs/table-view:
4455

0 commit comments

Comments
 (0)