Audit Logs

Audit Logs only available in a paid plan. Please activate a license key to use this feature.

Audit logs are a collection of notable events performed by users within a Sourcebot deployment. Each audit log records information on the action taken, the user who performed the action, and when the action took place. This feature gives security and compliance teams the necessary information to ensure proper governance and administration of your Sourcebot deployment.

Retention Policy

By default, audit logs older than 180 days are automatically pruned daily. You can configure the retention period using the SOURCEBOT_EE_AUDIT_RETENTION_DAYS environment variable. Set it to 0 to disable automatic pruning and retain logs indefinitely.

Fetching Audit Logs

Audit logs are stored in the postgres database connected to Sourcebot. To fetch all of the audit logs, you can use the following API:

Fetch audit logs

curl --request GET '$SOURCEBOT_URL/api/ee/audit' \
  --header 'X-Org-Domain: ~' \
  --header 'X-Sourcebot-Api-Key: $SOURCEBOT_OWNER_API_KEY'

Fetch audit logs example response

[
  {
    "id": "cmc146k7m0003xgo2tri5t4br",
    "timestamp": "2025-06-17T22:48:08.914Z",
    "action": "api_key.created",
    "actorId": "cmc12tnje0000xgn58jj8655h",
    "actorType": "user",
    "actorLabel": "jane@example.com",
    "targetId": "205d1da1c6c3772b81d4ad697f5851fa11195176c211055ff0c1509772645d6d",
    "targetType": "api_key",
    "targetLabel": "deploy",
    "sourcebotVersion": "unknown",
    "orgId": 1
  },
  {
    "id": "cmc12tnjx0004xgn5qqeiv1ao",
    "timestamp": "2025-06-17T22:10:07.101Z",
    "action": "user.owner_created",
    "actorId": "cmc12tnje0000xgn58jj8655h",
    "actorType": "user",
    "actorLabel": "jane@example.com",
    "targetId": "1",
    "targetType": "org",
    "targetLabel": null,
    "sourcebotVersion": "unknown",
    "metadata": null,
    "orgId": 1
  },
  {
    "id": "cmc12tnjh0002xgn5h6vzu3rl",
    "timestamp": "2025-06-17T22:10:07.086Z",
    "action": "user.signed_in",
    "actorId": "cmc12tnje0000xgn58jj8655h",
    "actorType": "user",
    "actorLabel": "jane@example.com",
    "targetId": "cmc12tnje0000xgn58jj8655h",
    "targetType": "user",
    "targetLabel": "jane@example.com",
    "sourcebotVersion": "unknown",
    "metadata": null,
    "orgId": 1
  }
]

Each record includes an actorLabel and a targetLabel. These are display names captured when the event is recorded, so a record stays readable after its actor or target is deleted.

Type	Label
`user`	The user’s email
`invite`	The invited email
`account_join_request`	The requesting user’s email
`api_key`, `scim_token`, `oauth_client`, `mcp_server`, `connection`, `chat`	The name of the key, token, client, server, connection, or chat
`account`	The identity provider ID (e.g., `github`)

Labels are null for types without a display name (e.g., org and system) and for records created before labels were added.

Audit action types

Usage events (code searches, code navigation, file views, repository listings, and Ask chats) are not recorded in the audit log. Records of these events created by earlier versions stay in the audit API until the retention policy prunes them.

Action	Actor Type	Target Type
`account.permissions_cleared`	`system`	`account`
`api_key.created`	`user`	`api_key`
`api_key.creation_failed`	`user`	`org`
`api_key.deleted`	`user`	`api_key`
`api_key.deletion_failed`	`user`	`org`
`audit.fetch`	`user`	`org`
`auth.token_rejected`	`anonymous`	`org`
`chat.deleted`	`user`	`chat`
`chat.shared_with_users`	`user`	`chat`
`chat.unshared_with_user`	`user`	`chat`
`chat.visibility_updated`	`user`	`chat`
`connection.permissions_enforcement_changed`	`system`	`connection`
`license.activated`	`user`	`license`
`license.activation_failed`	`user`	`license`
`license.deactivated`	`user`	`license`
`mcp_server.created`	`user`	`mcp_server`
`mcp_server.deleted`	`user`	`mcp_server`
`mcp_server.oauth_scopes_updated`	`user`	`mcp_server`
`mcp_server.tool_permissions_updated`	`user`	`mcp_server`
`oauth.authorization_granted`	`user`	`oauth_client`
`oauth_client.access_revoked`	`user`	`oauth_client`
`oauth_client.registered`	`anonymous`	`oauth_client`
`oauth_token.exchange_failed`	`anonymous`	`oauth_client`
`oauth_token.issued`	`oauth_client`	`user`
`oauth_token.refresh_failed`	`anonymous`	`oauth_client`
`oauth_token.refreshed`	`oauth_client`	`user`
`oauth_token.revoked`	`oauth_client`, `anonymous`	`user`
`org.credentials_login_updated`	`user`, `system`	`org`
`org.email_code_login_updated`	`user`, `system`	`org`
`org.invite_link_updated`	`user`	`org`
`org.login_message_updated`	`user`	`org`
`org.member_added`	`user`, `scim_token`	`user`
`org.member_approval_required_updated`	`user`, `system`	`org`
`org.member_deactivated`	`user`, `scim_token`	`user`
`org.member_left`	`user`, `scim_token`	`user`
`org.member_promoted_to_owner`	`user`, `scim_token`	`user`
`org.member_reactivated`	`user`, `scim_token`	`user`
`org.member_removed`	`user`, `scim_token`	`user`
`org.owner_demoted_to_member`	`user`, `scim_token`	`user`
`scim.disabled`	`user`	`org`
`scim.enabled`	`user`	`org`
`scim_token.auth_failed`	`anonymous`, `scim_token`	`org`
`scim_token.created`	`user`	`scim_token`
`scim_token.deleted`	`user`	`scim_token`
`scoped_access_token.created`	`api_key`	`scoped_access_token`
`scoped_access_token.deleted`	`api_key`	`scoped_access_token`
`user.account_linked`	`user`	`account`
`user.account_unlinked`	`user`	`account`
`user.created`	`user`, `scim_token`	`user`
`user.creation_failed`	`user`	`user`
`user.invite_accept_failed`	`user`	`invite`
`user.invite_accepted`	`user`	`invite`
`user.invite_cancelled`	`user`	`invite`
`user.invite_failed`	`user`	`org`
`user.invites_created`	`user`	`org`
`user.join_request_approve_failed`	`user`	`account_join_request`
`user.join_request_approved`	`user`	`account_join_request`
`user.list`	`user`	`org`
`user.mcp_server_connected`	`user`	`mcp_server`
`user.mcp_server_connection_failed`	`user`	`mcp_server`
`user.mcp_server_disconnected`	`user`	`mcp_server`
`user.owner_created`	`user`	`org`
`user.profile_updated`	`scim_token`	`user`
`user.read`	`user`	`user`
`user.sign_in_failed`	`anonymous`, `user`	`org`
`user.signed_in`	`user`	`user`
`user.signed_out`	`user`	`user`

Response schema

Audit log fetch response schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FetchAuditLogsResponse",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "timestamp",
      "action",
      "actorId",
      "actorType",
      "actorLabel",
      "targetId",
      "targetType",
      "targetLabel",
      "sourcebotVersion",
      "metadata",
      "orgId"
    ],
    "properties": {
      "id": {
        "type": "string"
      },
      "timestamp": {
        "type": "string",
        "format": "date-time"
      },
      "action": {
        "type": "string"
      },
      "actorId": {
        "type": "string"
      },
      "actorType": {
        "type": "string",
        "enum": ["user", "api_key", "scim_token", "anonymous", "system", "oauth_client"]
      },
      "actorLabel": {
        "type": ["string", "null"]
      },
      "targetId": {
        "type": "string"
      },
      "targetType": {
        "type": "string",
        "enum": ["user", "org", "file", "api_key", "account_join_request", "invite", "chat", "scim_token", "oauth_client", "account", "scoped_access_token", "mcp_server", "license", "connection"]
      },
      "targetLabel": {
        "type": ["string", "null"]
      },
      "sourcebotVersion": {
        "type": "string"
      },
      "metadata": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "message": { "type": ["string", "null"] },
              "api_key": { "type": "string" },
              "scim_token": { "type": "string" },
              "emails": { "type": "string" },
              "source": { "type": "string" },
              "enabled": { "type": "boolean" },
              "envVar": { "type": "string" },
              "reason": { "type": "string" },
              "serverUrl": { "type": "string" },
              "authMode": { "type": "string", "enum": ["static", "dynamic"] },
              "scopes": { "type": "array", "items": { "type": "string" } },
              "connectionCount": { "type": "integer" },
              "before": { "type": "array", "items": { "type": "string" } },
              "after": { "type": "array", "items": { "type": "string" } },
              "invalidatedConnectionCount": { "type": "integer" },
              "changes": {
                "type": "object",
                "additionalProperties": { "type": "string", "enum": ["ALLOWED", "NEEDS_APPROVAL", "DISABLED"] }
              },
              "tier": { "type": ["string", "null"] },
              "seatCap": { "type": ["integer", "null"] },
              "email": { "type": "string" },
              "field": { "type": "string", "enum": ["enforcePermissions", "enforcePermissionsForPublicRepos"] },
              "oldValue": { "type": "boolean" },
              "newValue": { "type": "boolean" },
              "clearedCount": { "type": "integer" },
              "provider": { "type": "string" },
              "providerId": { "type": "string" },
              "providerType": { "type": "string" },
              "viaEmailMatch": { "type": "boolean" },
              "tokenKind": { "type": "string", "enum": ["api_key", "oauth_access_token", "scoped_access_token", "access_token", "refresh_token"] },
              "changedFields": { "type": "array", "items": { "type": "string", "enum": ["name", "email"] } },
              "oldEmail": { "type": "string" },
              "newEmail": { "type": "string" },
              "repoIds": { "type": "array", "items": { "type": "integer" } },
              "expiresAt": { "type": "string", "format": "date-time" },
              "redirectUri": { "type": "string" },
              "resource": { "type": ["string", "null"] },
              "scope": { "type": "string" },
              "revokedTokenCount": { "type": "integer" },
              "name": { "type": "string" },
              "redirectUris": { "type": "array", "items": { "type": "string" } }
            },
            "additionalProperties": false
          },
          {
            "type": "null"
          }
        ]
      },
      "orgId": {
        "type": "integer"
      }
    },
    "additionalProperties": false
  }
}

Getting Started

Features

Configuration

Billing

Misc

Upgrade

Retention Policy

Fetching Audit Logs

Audit action types

Response schema

​Retention Policy

​Fetching Audit Logs

​Audit action types

​Response schema

Retention Policy

Fetching Audit Logs

Audit action types

Response schema