Skip to content

Commit 89e98b7

Browse files
add audit log event details (#2199)
1 parent 6ab77e6 commit 89e98b7

File tree

1 file changed

+52
-46
lines changed

1 file changed

+52
-46
lines changed

docs/hub/audit-logs.md

Lines changed: 52 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -32,60 +32,66 @@ You can also download the complete audit log as a JSON file for further analysis
3232

3333
## What Events Are Tracked?
3434

35+
Each action has an **event name** in `scope.action` format (e.g. `repo.create`, `collection.delete`). This is the `type` field in each log entry and in the exported JSON—use it when searching or filtering logs.
36+
3537
### Organization Management & Security
3638

37-
- Core organization changes
38-
- Creation, deletion, and restoration
39-
- Name changes and settings updates
40-
- Security management
41-
- Security token rotation
42-
- Token approval system (enabling/disabling, authorization requests, approvals, denials, revocations)
43-
- SSO events (logins and joins)
39+
- **Core organization changes** — Creation, deletion, restoration, renaming, and profile/settings updates.
40+
- **Events:** `org.create`, `org.delete`, `org.restore`, `org.rename`, `org.update_settings`
41+
- **Security management**
42+
- Organization API token rotation.
43+
- **Event:** `org.rotate_token`
44+
- Token approval system — Enabling or disabling the policy, authorization requests, approvals, denials, and revocations.
45+
- **Events:** `org.token_approval.enabled`, `org.token_approval.disabled`, `org.token_approval.authorization_request`, `org.token_approval.authorization_request.authorized`, `org.token_approval.authorization_request.revoked`, `org.token_approval.authorization_request.denied`
46+
- SSO — Logins and joins via SSO.
47+
- **Events:** `org.sso_login`, `org.sso_join`
48+
- **Join settings** — Domain-based access and automatic join configuration.
49+
- **Event:** `org.update_join_settings`
4450

4551
### Membership and Access Control
4652

47-
- Member lifecycle
48-
- Invitations (sending, accepting) and automatic joins
49-
- Adding and removing members
50-
- Role changes and departures
51-
- Join settings
52-
- Domain-based access
53-
- Automatic join configurations
53+
- **Member lifecycle** — Adding and removing members, role changes, and members leaving the organization.
54+
- **Events:** `org.add_user`, `org.remove_user`, `org.change_role`, `org.leave`
55+
- **Invitations** — Sending invites, invitation links by email, and users accepting invites.
56+
- **Events:** `org.invite_user`, `org.invite.accept`, `org.invite.email`
57+
- **Automatic joins** — Joins via verified email domain or “request access”.
58+
- **Events:** `org.join.from_domain`, `org.join.automatic`
5459

5560
### Content and Resource Management
5661

57-
- Repository administration
58-
- Core actions (creation, deletion, moving, duplication)
59-
- Settings and configuration changes
60-
- Enabling/disabling repositories
61-
- DOI management
62-
- Resource group assignments
63-
- Collections
64-
- Creation and deletion events
65-
- Repository security
66-
- Secrets management (individual and bulk)
67-
- Variables handling (individual and bulk)
68-
- Spaces configuration
69-
- Storage modifications
70-
- Hardware settings
71-
- Sleep time adjustments
72-
73-
### Billing and AWS Integration
74-
75-
- Payment management
76-
- Payment methods (adding/removing)
77-
- Customer account creation
78-
- AWS integration setup and removal
79-
- Subscription lifecycle
80-
- Starting and renewing
81-
- Updates and cancellations
82-
- Cancellation reversals
62+
- **Repository administration** — Creation, deletion, moving, disabling/re-enabling, duplication settings, DOI removal, resource group assignment, and general repo settings (visibility, gating, discussions, etc.). Also LFS file deletion.
63+
- **Events:** `repo.create`, `repo.delete`, `repo.move`, `repo.disable`, `repo.removeDisable`, `repo.duplication`, `repo.delete_doi`, `repo.update_resource_group`, `repo.update_settings`, `repo.delete_lfs_file`
64+
- **Collections** — Creation and deletion of collections.
65+
- **Events:** `collection.create`, `collection.delete`
66+
- **Repository security** — Secrets and variables (individual and bulk add/update/remove).
67+
- **Events (secrets):** `repo.add_secret`, `repo.update_secret`, `repo.remove_secret`, `repo.add_secrets`, `repo.remove_secrets`
68+
- **Events (variables):** `repo.add_variable`, `repo.update_variable`, `repo.remove_variable`, `repo.add_variables`, `repo.remove_variables`
69+
- **Spaces configuration** — Storage tier changes, hardware (flavor) updates, and sleep time adjustments.
70+
- **Events:** `spaces.add_storage`, `spaces.remove_storage`, `spaces.update_hardware`, `spaces.update_sleep_time`
8371

8472
### Resource Groups
8573

86-
- Administrative actions
87-
- Creation and deletion
88-
- Settings modifications
89-
- Member management
90-
- Adding and removing users
91-
- Role assignments and changes
74+
- **Resource group administration** — Creation, deletion, and settings changes.
75+
- **Events:** `resource_group.create`, `resource_group.delete`, `resource_group.settings`
76+
- **Resource group members** — Adding and removing users, and role changes.
77+
- **Events:** `resource_group.add_users`, `resource_group.remove_users`, `resource_group.change_role`
78+
79+
### Jobs and Scheduled Jobs
80+
81+
- **Jobs** — Job creation (e.g. on a Space) and cancellation.
82+
- **Events:** `jobs.create`, `jobs.cancel`
83+
- **Scheduled jobs** — Creating, deleting, resuming, suspending, and triggering runs.
84+
- **Events:** `scheduled_job.create`, `scheduled_job.delete`, `scheduled_job.resume`, `scheduled_job.suspend`, `scheduled_job.run`
85+
86+
### Billing and Cloud Integration
87+
88+
- **Payment and customers** — Payment method updates, attachment, and removal; customer account creation.
89+
- **Events:** `billing.update_payment_method`, `billing.create_customer`, `billing.remove_payment_method`
90+
- **Cloud marketplaces** — AWS and GCP marketplace linking/unlinking and marketplace approval.
91+
- **Events:** `billing.aws_add`, `billing.aws_remove`, `billing.gcp_add`, `billing.gcp_remove`, `billing.marketplace_approve`
92+
- **Subscriptions** — Starting, renewing, cancelling, reactivating, and updating subscriptions (including plan and contract details).
93+
- **Events:** `billing.start_subscription`, `billing.renew_subscription`, `billing.cancel_subscription`, `billing.un_cancel_subscription`, `billing.update_subscription`, `billing.update_subscription_plan`, `billing.update_subscription_contract_details`
94+
95+
## Event reference
96+
97+
The list above covers every event type shown in the audit log UI and export. Event names follow the `scope.action` pattern; scopes include `org`, `repo`, `collection`, `spaces`, `resource_group`, `jobs`, `scheduled_job`, and `billing`. The export action itself is recorded as `org.audit_log.export` but that event is not included in the default audit log view.

0 commit comments

Comments
 (0)