Skip to content

Commit 78db636

Browse files
docs: bring audit log docs in sync with code
The action type table in docs/docs/configuration/audit-logs.mdx was missing four entries that the code actually writes (org.member_deactivated, org.member_reactivated, scim_token.created, scim_token.deleted) and had one stale entry the code never writes (user.delete). The page also did not document the four query parameters (page, perPage, since, until) or the two response headers (X-Total-Count, Link) that the public OpenAPI spec already describes. The targetType enum and metadata schema on the same page are updated to include scim_token.
1 parent 6ce7a86 commit 78db636

1 file changed

Lines changed: 39 additions & 6 deletions

File tree

docs/docs/configuration/audit-logs.mdx

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,6 @@ curl --request GET '$SOURCEBOT_URL/api/ee/audit' \
124124
| `chat.visibility_updated` | `user` | `chat` |
125125
| `user.created_ask_chat` | `user` | `org` |
126126
| `user.creation_failed` | `user` | `user` |
127-
| `user.delete` | `user` | `user` |
128127
| `user.fetched_file_blame` | `user` | `org` |
129128
| `user.fetched_file_source` | `user` | `org` |
130129
| `user.fetched_file_tree` | `user` | `org` |
@@ -143,11 +142,44 @@ curl --request GET '$SOURCEBOT_URL/api/ee/audit' \
143142
| `user.read` | `user` | `user` |
144143
| `user.signed_in` | `user` | `user` |
145144
| `user.signed_out` | `user` | `user` |
146-
| `org.member_promoted_to_owner` | `user` | `user` |
147-
| `org.owner_demoted_to_member` | `user` | `user` |
148145
| `org.member_added` | `user` | `user` |
149-
| `org.member_removed` | `user` | `user` |
146+
| `org.member_deactivated` | `user` | `user` |
150147
| `org.member_left` | `user` | `user` |
148+
| `org.member_reactivated` | `user` | `user` |
149+
| `org.member_removed` | `user` | `user` |
150+
| `org.member_promoted_to_owner` | `user` | `user` |
151+
| `org.owner_demoted_to_member` | `user` | `user` |
152+
| `scim_token.created` | `user` | `scim_token` |
153+
| `scim_token.deleted` | `user` | `scim_token` |
154+
155+
156+
## Query parameters and response headers
157+
158+
The endpoint is paginated and accepts a time range filter.
159+
160+
### Query parameters
161+
162+
| Parameter | Type | Default | Description |
163+
| :------- | :------ | :------ | :------ |
164+
| `page` | positive integer | `1` | Page number. |
165+
| `perPage` | positive integer, max `100` | `50` | Number of records per page. |
166+
| `since` | ISO 8601 timestamp || Return records at or after this timestamp (inclusive). |
167+
| `until` | ISO 8601 timestamp || Return records at or before this timestamp (inclusive). |
168+
169+
`since` must be strictly before `until` if both are supplied; otherwise the endpoint returns `400`.
170+
171+
### Response headers
172+
173+
| Header | Description |
174+
| :------- | :------ |
175+
| `X-Total-Count` | Total number of audit records matching the current `since` / `until` filter across all pages. |
176+
| `Link` | Pagination links (`rel="first"`, `rel="prev"`, `rel="next"`, `rel="last"`) formatted per [RFC 8288](https://datatracker.ietf.org/doc/html/rfc8288). Only set when more than one page of results exists. |
177+
178+
```bash icon="terminal" Fetch audit logs for a time range, then page
179+
curl --request GET '$SOURCEBOT_URL/api/ee/audit?since=2026-08-01T00:00:00Z&until=2026-08-13T23:59:59Z&perPage=25' \
180+
--header 'X-Org-Domain: ~' \
181+
--header 'X-Sourcebot-Api-Key: $SOURCEBOT_OWNER_API_KEY'
182+
```
151183

152184

153185
## Response schema
@@ -194,7 +226,7 @@ curl --request GET '$SOURCEBOT_URL/api/ee/audit' \
194226
},
195227
"targetType": {
196228
"type": "string",
197-
"enum": ["user", "org", "file", "api_key", "account_join_request", "invite", "chat"]
229+
"enum": ["user", "org", "file", "api_key", "account_join_request", "invite", "chat", "scim_token"]
198230
},
199231
"sourcebotVersion": {
200232
"type": "string"
@@ -207,7 +239,8 @@ curl --request GET '$SOURCEBOT_URL/api/ee/audit' \
207239
"message": { "type": "string" },
208240
"api_key": { "type": "string" },
209241
"emails": { "type": "string" },
210-
"source": { "type": "string" }
242+
"source": { "type": "string" },
243+
"scim_token": { "type": "string" }
211244
},
212245
"additionalProperties": false
213246
},

0 commit comments

Comments
 (0)