Skip to content

Commit

Permalink
Document user groups and revised permissions (#814)
Browse files Browse the repository at this point in the history
* Document user groups and revised permissions

* Complete user groups documentation
  • Loading branch information
janet-can committed Jul 8, 2024
1 parent 2633c79 commit 5d67a28
Show file tree
Hide file tree
Showing 16 changed files with 250 additions and 164 deletions.
4 changes: 3 additions & 1 deletion _data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,10 @@
page: soda-cloud/organize-datasets.md
- subtitle: Create and track incidents
page: soda-cloud/incidents.md
- subtitle: Set roles and rights
- subtitle: Manage account roles
page: soda-cloud/roles-and-rights.md
- subtitle: Manage resource permissions
page: soda-cloud/roles-resources.md

- title: Integrate Soda
page: soda/integrate-alation.md
Expand Down
10 changes: 10 additions & 0 deletions _release-notes/user-groups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: "User groups"
date: 2024-07-08
products:
- soda-cloud
---

Create user groups in Soda Cloud to manage role-based permissions (**Admin**, **Manager**, **Editor**, **Viewer**) to resources. Once created, assign role-based permission to access a dataset to user groups, or assign user groups as alert notification rules recipients, and more.

Refer to [Create custom user groups]({% link soda-cloud/roles-and-rights.md %}#create-custom-user-groups) for details.
2 changes: 1 addition & 1 deletion soda-agent/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -1354,7 +1354,7 @@ This tab is the fifth step in the guided workflow if the **5. Check** tab is abs
| Field or Label | Guidance |
|----------------|----------|
| Data Source Owner | The Data Source Owner maintains the connection details and settings for this data source and its Default Scan Definition. |
| Default Dataset Owner | The Datasets Owner is the user who, by default, becomes the owner of each dataset the Default Scan discovers. Refer to [Roles and Rights in Soda Cloud]({% link soda-cloud/roles-and-rights.md %}) to learn how to adjust the Dataset Owner of individual datasets.|
| Default Dataset Owner | The Datasets Owner is the user who, by default, becomes the owner of each dataset the Default Scan discovers. Refer to [Manage roles and permissions in Soda Cloud]({% link soda-cloud/roles-and-rights.md %}) to learn how to adjust the Dataset Owner of individual datasets.|

<br />

Expand Down
2 changes: 1 addition & 1 deletion soda-agent/managed-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ This tab is the fifth step in the guided workflow if the **5. Check** tab is abs
| Field or Label | Guidance |
|----------------|----------|
| Data Source Owner | The Data Source Owner maintains the connection details and settings for this data source and its Default Scan Definition. |
| Default Dataset Owner | The Datasets Owner is the user who, by default, becomes the owner of each dataset the Default Scan discovers. Refer to [Roles and Rights in Soda Cloud]({% link soda-cloud/roles-and-rights.md %}) to learn how to adjust the Dataset Owner of individual datasets.|
| Default Dataset Owner | The Datasets Owner is the user who, by default, becomes the owner of each dataset the Default Scan discovers. Refer to [Manage roles and permissions in Soda Cloud]({% link soda-cloud/roles-and-rights.md %}) to learn how to adjust the Dataset Owner of individual datasets.|

<br />

Expand Down
2 changes: 1 addition & 1 deletion soda-cl/check-attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Use attributes to organize your checks and alert notifications in Soda Cloud.
## Prerequisites
* To *define* new check attributes, you must have [Admin rights]({% link soda-cloud/roles-and-rights.md %}) on your Soda Cloud account. Any Soda Cloud user or Soda Library user can *apply* existing attributes to new or existing checks.
* To *define* new check attributes, you must have [Admin permissions]({% link soda-cloud/roles-and-rights.md %}) on your Soda Cloud account. Any Soda Cloud user or Soda Library user can *apply* existing attributes to new or existing checks.
## Define a check attribute
Expand Down
2 changes: 1 addition & 1 deletion soda-cl/soda-cl-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Create **no-code checks** for data quality directly in the Soda Cloud user inter
* You, or an Admin on your Soda Cloud account, has [deployed a Soda Agent]({% link soda-agent/deploy.md %}) version 0.8.52 or greater, and connected it to your Soda Cloud account.
* You, or an Admin on your Soda Cloud account, has [added a new datasource]({% link soda-agent/deploy.md %}#add-a-new-data-source) via the Soda Agent in your Soda Cloud account *and* configured the data source to [discover the datasets]({% link soda-cl/profile.md %}#add-dataset-discovery) in the data source for which you want to write no-code checks. (Soda must have access to dataset names and column names to present those values in dropdown menus during no-code check creation.)
* You must have permission to edit the dataset as an Admin, Manager, or Editor; see [Roles and rights]({% link soda-cloud/roles-and-rights.md %}).
* You must have permission to edit the dataset as an Admin, Manager, or Editor; see [Manage roles and permissions]({% link soda-cloud/roles-and-rights.md %}).
### Create a new check
Expand Down
2 changes: 1 addition & 1 deletion soda-cloud/anomaly-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Activate an anomaly dashboard to one or more datasets by configuring profiling f
Use the following procedure to activate the anomaly dashboard for an existing dataset in a data source you already connected to your Soda Cloud account via a self-hosted or Soda-hosted agent.
1. If you have Admin, Manager, or Editor [rights]({% link soda-cloud/roles-and-rights.md %}) to a dataset, navigate to the **Datasets** dashboard, then open the dataset to which you wish to activate an anomaly dashboard.
1. If you have been assigned an Admin, Manager, or Editor [role]({% link soda-cloud/roles-and-rights.md %}#access-to-resources) for a dataset, navigate to the **Datasets** dashboard, then open the dataset to which you wish to activate an anomaly dashboard.
2. Navigate to the **Anomalies** tab where a message appears that advises you that the anomaly dashboard has not been activated for this dataset. Click **Activate**.
3. Follow the guided steps and carefully read the warning about the changes to any existing profiling you have configured for the data source (see below). If you accept the permanent changes, specify the time of day you wish to run the daily anomaly scan, then proceed.
><hr>
Expand Down
2 changes: 1 addition & 1 deletion soda-cloud/collaborate.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Invite the members of your team to join you in your work to monitor data quality

In your Soda Cloud account, navigate to **your avatar** > **Invite Team Members** and fill in the blanks.

When your team members receive the invitation email, they can click the link in the email to create their own login credentials to access your Soda Cloud account directly. Refer to [Default roles and groups]({% link soda-cloud/roles-and-rights.md %}#default-roles-and-groups) to learn more about the default access rights Soda Cloud assigns to new users.
When your team members receive the invitation email, they can click the link in the email to create their own login credentials to access your Soda Cloud account directly. Refer to [Default roles and groups]({% link soda-cloud/roles-and-rights.md %}#default-roles-and-permissions) to learn more about the default access rights Soda Cloud assigns to new users.

Note that if your organization uses a single sign-on (SSO) identity provider to access Soda Cloud, you cannot invite team members in Soda Cloud. Instead, contact your IT Admin to request access to Soda Cloud using your SSO. See also, [Single Sign-on with Soda Cloud]({% link soda-cloud/sso.md %}).

Expand Down
2 changes: 1 addition & 1 deletion soda-cloud/organize-datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Define new attributes for datasets in your organization that your colleagues can

<br />

1. As an [Admin member]({% link soda-cloud/roles-and-rights.md %}) of your Soda Cloud account, navigate to **your avatar** > **Attributes** > **New Attribute**.
1. As an [Admin]({% link soda-cloud/roles-and-rights.md %}) of your Soda Cloud account, navigate to **your avatar** > **Attributes** > **New Attribute**.
2. Follow the guided steps to create the new attribute. Use the details below for insight into the values to enter in the fields in the guided steps.

| Field or Label | Guidance |
Expand Down
Loading

0 comments on commit 5d67a28

Please sign in to comment.