Skip to content

Commit cf6fbad

Browse files
committed
add hub audit logs
1 parent 0f8302c commit cf6fbad

File tree

5 files changed

+66
-0
lines changed

5 files changed

+66
-0
lines changed

source/hub/audit-logs.rst

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
.. _hub/audit-logs:
2+
3+
Audit Logs
4+
==========
5+
6+
The Audit Logs provide an overview of security-related events within Cryptomator Hub.
7+
These logs allow administrators to track important account and vault-related actions.
8+
9+
.. note::
10+
Audit Logs are not available with a Community License.
11+
12+
.. _hub/audit-logs/event-list:
13+
14+
Event Types
15+
-----------
16+
17+
The following events are logged:
18+
19+
- **DeviceRegister** – A device has been registered.
20+
- **DeviceRemove** – A device has been removed.
21+
- **SettingWotUpdate** – A Web-of-Trust setting has been updated.
22+
- **SignedWotId** – A Web-of-Trust identity has been signed.
23+
- **UserAccountReset** – A user account has been reset.
24+
- **VaultAccessGrant** – Access to a vault has been granted.
25+
- **VaultCreate** – A vault has been created.
26+
- **VaultKeyRetrieve** – A vault key has been retrieved.
27+
- **VaultMemberAdd** – A member has been added to a vault.
28+
- **VaultMemberRemove** – A member has been removed from a vault.
29+
- **VaultMemberUpdate** – A vault member’s permissions have been updated.
30+
- **VaultOwnershipClaim** – Vault ownership has been claimed.
31+
- **VaultUpdate** – A vault has been updated.
32+
- **UserKeysChange** – User keys have been changed.
33+
- **UserSetupCodeChanged** – A user’s setup code has been changed.
34+
35+
.. _hub/audit-logs/table-view:
36+
37+
Audit Log Table View
38+
--------------------
39+
40+
The logs are displayed in a structured table containing the following columns:
41+
42+
- **Timestamp** – The exact time of the event.
43+
- **Event** – The type of event that occurred.
44+
- **Details** – Additional information about the event.
45+
46+
.. image:: ../img/hub/auditlogs-overview.png
47+
:alt: Audit Logs Table View
48+
49+
Each page contains up to 20 entries, with pagination controls at the bottom.
50+
51+
.. _hub/audit-logs/filters:
52+
53+
Filtering Audit Logs
54+
--------------------
55+
56+
To refine the displayed logs, a filtering function is available:
57+
58+
.. image:: ../img/hub/auditlogs-filter.png
59+
:alt: Audit Log Filtering Options
60+
61+
- **Date Range Filter**: Allows filtering logs between two specific dates.
62+
- **Event Type Filter**: A multi-select dropdown enables filtering by event type.
63+
64+
.. image:: ../img/hub/auditlogs-filter-events.png
65+
:alt: Audit Log Filtering Options
102 KB
Loading

source/img/hub/auditlogs-filter.png

56.2 KB
Loading

source/img/hub/auditlogs-overview.png

301 KB
Loading

source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ If you are interested in the security of Cryptomator, have a look at our :ref:`s
6767
hub/vault-management.rst
6868
hub/access-vault.rst
6969
hub/vault-recovery.rst
70+
hub/audit-logs.rst
7071

7172
.. toctree::
7273
:hidden:

0 commit comments

Comments
 (0)