Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AMP-109903 Update docs for data permission restrictions #339

Merged
merged 5 commits into from
Oct 22, 2024
Merged

AMP-109903 Update docs for data permission restrictions #339

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
59fe0d7
update docs for data permission restrictions
cyhk Oct 18, 2024
2dc2107
update wording
cyhk Oct 18, 2024
e9cdac6
Apply suggestions from code review
cyhk Oct 19, 2024
59bd0c9
add line about permissions tab being enterprise only
cyhk Oct 21, 2024
22e70ce
change wording of first two paragraphs
cyhk Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 52 additions & 28 deletions content/collections/data/en/amplitude-data-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
---
id: 9fbd24d0-c90c-497c-8cca-5b345f1058d6
blueprint: data
title: 'Manage your Amplitude Data settings'
source: 'https://help.amplitude.com/hc/en-us/articles/5078848559259-Configure-and-manage-your-Amplitude-Data-settings'
title: "Manage your Amplitude Data settings"
source: "https://help.amplitude.com/hc/en-us/articles/5078848559259-Configure-and-manage-your-Amplitude-Data-settings"
this_article_will_help_you:
- 'Understand and manage all settings related to your Amplitude Data projects'
- "Understand and manage all settings related to your Amplitude Data projects"
landing: false
exclude_from_sitemap: false
updated_by: 5817a4fa-a771-417a-aa94-a0b1e7f55eae
updated_at: 1725397992
---

In the Settings page, you can:

* Name your project, and specify the naming conventions you’ll use for events and properties
* Specify whether you’ll require team reviews for all changes to main
* Set the Amplitude projects for your environments
* Add integrations
* Generate API tokens
* Delete your Amplitude Data project
- Name your project, and specify the naming conventions you’ll use for events and properties
- Specify whether you’ll require team reviews for all changes to main
- Set the Amplitude projects for your environments
- Add integrations
- Generate API tokens
- Delete your Amplitude Data project

Find these settings and features on five different tabs: General; Environments; Integrations; API Tokens; and Schema Settings. This article describes each tab below.

Expand All @@ -27,15 +28,18 @@

## Roles and permissions in Amplitude Data

| Role | Permissions |
| --- | --- |
| Admin | Configure workspace settings, approve tracking plan changes, and modify the tracking plan |
| Manager | Approve tracking plan changes and modify the tracking plan |
| Member | Modify the tracking plan for approval |
| Viewer | View the tracking plan and comment |
| Role | Permissions |
| ------- | ----------------------------------------------------------------------------------------- |
| Admin | Configure workspace settings, approve tracking plan changes, and modify the tracking plan |
| Manager | Approve tracking plan changes and modify the tracking plan |
| Member | Modify the tracking plan for approval |
| Viewer | View the tracking plan and comment |

You may also restrict data management access while keeping permissions the same for other areas of Amplitude. See [The Permissions Tab](#the-permissions-tab) for more details.

{{partial:admonition type="info" heading=""}}
If you disable the *Require team reviews to make changes to the main branch* option in the project settings, members can modify the tracking plan; however, receiving approval would no longer be required. All other permissions remain the same.
If you disable the _Require team reviews to make changes to the main branch_ option in the project settings, members can modify the tracking plan; however, receiving approval would no longer be required. All other permissions remain the same.

{{/partial:admonition}}

## The General tab
Expand All @@ -48,12 +52,12 @@

Specify a custom naming convention, or choose from the following:

* lower case
* Sentence case
* Title Case
* CamelCase
* lowerCamelCase
* snake\_case
- lower case
- Sentence case
- Title Case
- CamelCase
- lowerCamelCase
- snake_case

### Team reviews

Expand All @@ -65,21 +69,21 @@

### Public link to your tracking plan

If you ever want to share your tracking plan, you can do so using the public link provided here on the *General* tab. Just copy it to your clipboard and paste it into an email or Slack message. Stakeholders can read it, but they can’t make any changes themselves.
If you ever want to share your tracking plan, you can do so using the public link provided here on the _General_ tab. Just copy it to your clipboard and paste it into an email or Slack message. Stakeholders can read it, but they can’t make any changes themselves.

You can also enable or disable the public link, which changes the availability for the selected project. Just click *Create Public Link* or *Delete Public Link*.
You can also enable or disable the public link, which changes the availability for the selected project. Just click _Create Public Link_ or _Delete Public Link_.

## The Integrations tab

You can integrate Amplitude Data with your existing tools to streamline your analytics workflow. To integrate a platform, simply click *Connect* or *Add* next to its name.
You can integrate Amplitude Data with your existing tools to streamline your analytics workflow. To integrate a platform, simply click _Connect_ or _Add_ next to its name.

## The API Tokens tab

Use API tokens to authenticate to Amplitude Data using credentials other than your email address and a password. Tokens authorize applications to enjoy the same roles and permissions granted to you when you log in personally.

To create an API token, click *Create Token*. Amplitude Data generates the token and display it in a modal window.
To create an API token, click _Create Token_. Amplitude Data generates the token and display it in a modal window.

Be sure to click *Copy to clipboard* now, as you won’t be able to retrieve the token later.
Be sure to click _Copy to clipboard_ now, as you won’t be able to retrieve the token later.

## The Schema Settings tab

Expand All @@ -89,4 +93,24 @@

For any unplanned events, event properties, event property types, user properties, or user property types, you can tell Amplitude Data to either mark them as **unexpected**, or to **reject** them outright. Amplitude Data ingests any events or properties marked as unexpected and send a notification to everyone subscribed to this schema. If you choose to reject unexpected data, however, Amplitude Data doesn't ingest or store the rejected data. Subscribers still receive a notification.

Click *Save* to implement any changes you make to your schema settings.
Click _Save_ to implement any changes you make to your schema settings.

## The Permissions Tab

Check warning on line 98 in content/collections/data/en/amplitude-data-settings.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Headings] 'The Permissions Tab' should use sentence-style capitalization.

Raw Output:
{"message": "[Amplitude.Headings] 'The Permissions Tab' should use sentence-style capitalization.", "location": {"path": "content/collections/data/en/amplitude-data-settings.md", "range": {"start": {"line": 98, "column": 4}}}, "severity": "WARNING"}
cyhk marked this conversation as resolved.
Show resolved Hide resolved

Your company may want to limit the number of people who have access to perform Data Management functions. For example, you may want most of your users to have the Member role so they can create dashboards and charts but prefer that custom event creation and other data management features be limited to managers or administrators.

Check warning on line 100 in content/collections/data/en/amplitude-data-settings.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Passive] 'be limited' looks like passive voice.

Raw Output:
{"message": "[Amplitude.Passive] 'be limited' looks like passive voice.", "location": {"path": "content/collections/data/en/amplitude-data-settings.md", "range": {"start": {"line": 100, "column": 290}}}, "severity": "WARNING"}
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved

In the permissions tab, you can add additional restrictions for selected roles, limiting data management access while keeping other permissions for those roles.

Under Restrict access in Amplitude Data, you can specify from the following options to restrict permissions to the viewer level on a per-project basis:
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved

- Use Default Restrictions
- Restrict Members
- Restrict Members and Managers

Then, click _Save_.

The Permissions tab is only visible to admins and permission restrictions cannot be applied to admins themselves.

Check warning on line 112 in content/collections/data/en/amplitude-data-settings.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Contractions] Use 'can't' instead of 'cannot'.

Raw Output:
{"message": "[Amplitude.Contractions] Use 'can't' instead of 'cannot'.", "location": {"path": "content/collections/data/en/amplitude-data-settings.md", "range": {"start": {"line": 112, "column": 75}}}, "severity": "WARNING"}

Check warning on line 112 in content/collections/data/en/amplitude-data-settings.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Passive] 'be applied' looks like passive voice.

Raw Output:
{"message": "[Amplitude.Passive] 'be applied' looks like passive voice.", "location": {"path": "content/collections/data/en/amplitude-data-settings.md", "range": {"start": {"line": 112, "column": 82}}}, "severity": "WARNING"}
markzegarelli marked this conversation as resolved.
Show resolved Hide resolved

### Copy to Other Projects

Check warning on line 114 in content/collections/data/en/amplitude-data-settings.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Amplitude.Headings] 'Copy to Other Projects' should use sentence-style capitalization.

Raw Output:
{"message": "[Amplitude.Headings] 'Copy to Other Projects' should use sentence-style capitalization.", "location": {"path": "content/collections/data/en/amplitude-data-settings.md", "range": {"start": {"line": 114, "column": 5}}}, "severity": "WARNING"}
cyhk marked this conversation as resolved.
Show resolved Hide resolved

You can also copy current permission restriction settings to other projects by clicking on the _Copy to Other Projects_ button. To copy settings, select the desired projects and click _Save_.
cyhk marked this conversation as resolved.
Show resolved Hide resolved
Loading