Skip to content

Commit

Permalink
Updaing audit log definitions (#6415)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

Adds audit log events

Closes #6406

## Checklist
- [ ] I have reviewed the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [ ] The topic I'm writing about is for specific dbt version(s) and I
have versioned it according to the [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and/or [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content)
guidelines.
- [ ] I have added checklist item(s) to this list for anything anything
that needs to happen before this PR is merged, such as "needs technical
review" or "change base branch."
- [ ] The content in this PR requires a dbt release note, so I added one
to the [release notes
page](https://docs.getdbt.com/docs/dbt-versions/dbt-cloud-release-notes).
<!--
PRE-RELEASE VERSION OF dbt (if so, uncomment):
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
<!-- 
ADDING OR REMOVING PAGES (if so, uncomment):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/vercel.json`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages
-->

<!-- vercel-deployment-preview -->
---
🚀 Deployment available! Here are the direct links to the updated files:


-
https://docs-getdbt-com-git-update-audit-dbt-labs.vercel.app/docs/cloud/manage-access/audit-log

<!-- end-vercel-deployment-preview -->

---------

Co-authored-by: Mirna Wong <[email protected]>
  • Loading branch information
matthewshaver and mirnawong1 authored Nov 7, 2024
1 parent 0583b56 commit 3417896
Showing 1 changed file with 57 additions and 4 deletions.
61 changes: 57 additions & 4 deletions website/docs/docs/cloud/manage-access/audit-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The audit log supports various events for different objects in dbt Cloud. You wi
| Auth Provider Changed | auth_provider.Changed | Authentication provider settings changed |
| Credential Login Succeeded | auth.CredentialsLoginSucceeded | User successfully logged in with username and password |
| SSO Login Failed | auth.SsoLoginFailed | User login via SSO failed |
| SSO Login Succeeded | auth.SsoLoginSucceeded | User successfully logged in via SSO
| SSO Login Succeeded | auth.SsoLoginSucceeded | User successfully logged in via SSO |

### Environment

Expand Down Expand Up @@ -93,7 +93,7 @@ The audit log supports various events for different objects in dbt Cloud. You wi
| ------------- | ----------------------------- | ------------------------------ |
| Group Added | user_group.Added | New Group successfully created |
| Group Changed | user_group.Changed | Group settings changed |
| Group Removed | user_group.Changed | Group successfully removed |
| Group Removed | user_group.Removed | Group successfully removed |

### User

Expand Down Expand Up @@ -149,12 +149,65 @@ The audit log supports various events for different objects in dbt Cloud. You wi

### Credentials

| Event Name | Event Type | Description |
| -------------------------------- | ----------------------------- | -------------------------------- |
| Event Name | Event Type | Description |
| -------------------------------- | ----------------------------- | -----------------------|
| Credentials Added to Project | credentials.Added | Project credentials added |
| Credentials Changed in Project | credentials.Changed | Credentials changed in project |
| Credentials Removed from Project | credentials.Removed | Credentials removed from project |


### Git integration

| Event Name | Event Type | Description |
| -------------------------------- | ----------------------------- | -----------------------|
| GitLab Application Changed | gitlab_application.changed | GitLab configuration in dbt Cloud changed |

### Webhooks

| Event Name | Event Type | Description |
| -------------------------------- | ----------------------------- | -----------------------|
| Webhook Subscriptions Added | webhook_subscription.added | New webhook configured in settings |
| Webhook Subscriptions Changed | webhook_subscription.changed | Existing webhook configuration altered |
| Webhook Subscriptions Removed | webhook_subscription.removed | Existing webhook deleted |


### Semantic Layer

| Event Name | Event Type | Description |
| -------------------------------- | ----------------------------- | -----------------------|
| Semantic Layer Config Added | semantic_layer_config.added | Semantic Layer config added |
| Semantic Layer Config Changed | semantic_layer_config.changed | Semantic Layer config (not related to credentials) changed |
| Semantic Layer Config Removed | semantic_layer_config.removed | Semantic Layer config removed |
| Semantic Layer Credentials Added | semantic_layer_credentials.added | Semantic Layer credentials added |
| Semantic Layer Credentials Changed| semantic_layer_credentials.changed | Semantic Layer credentials changed. Does not trigger semantic_layer_config.changed|
| Semantic Layer Credentials Removed| semantic_layer_credentials.removed | Semantic Layer credentials removed |

### Extended attributes

| Event Name | Event Type | Description |
| -------------------------------- | ----------------------------- | -----------------------|
| Extended Attribute Added | extended_attributes.added | Extended attribute added to a project |
| Extended Attribute Changed | extended_attributes.changed | Extended attribute changed or removed |


### Account-scoped personal access token

| Event Name | Event Type | Description |
| -------------------------------- | ----------------------------- | -----------------------|
| Account Scoped Personal Access Token Created | account_scoped_pat.created | An account-scoped PAT was created |
| Account Scoped Personal Access Token Deleted | account_scoped_pat.deleted | An account-scoped PAT was deleted |

### IP restrictions

| Event Name | Event Type | Description |
| -------------------------------- | ----------------------------- | -----------------------|
| IP Restrictions Toggled | ip_restrictions.toggled | IP restrictions feature enabled or disabled |
| IP Restrictions Rule Added | ip_restrictions.rule.added | IP restriction rule created |
| IP Restrictions Rule Changed | ip_restrictions.rule.changed | IP restriction rule edited |
| IP Restrictions Rule Removed | ip_restrictions.rule.removed | IP restriction rule deleted |



## Searching the audit log

You can search the audit log to find a specific event or actor, which is limited to the ones listed in [Events in audit log](#events-in-audit-log). The audit log successfully lists historical events spanning the last 90 days. You can search for an actor or event using the search bar, and then narrow your results using the time window.
Expand Down

0 comments on commit 3417896

Please sign in to comment.