-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8990e57
commit 4d0cc54
Showing
1 changed file
with
84 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,88 @@ | ||
--- | ||
title: "User management" | ||
title: "Managing users in Dagster+" | ||
displayed_sidebar: "dagsterPlus" | ||
sidebar_position: 1 | ||
sidebar_label: "User management" | ||
sidebar_position: 10 | ||
--- | ||
|
||
# User management in Dagster+ | ||
Dagster+ allows you to grant specific permissions to your organization's users, ensuring that Dagster users have access only to what they require. | ||
|
||
In this guide, you'll learn how to manage users and their permissions using the Dagster+ UI. | ||
|
||
<details> | ||
<summary>Prerequisites</summary> | ||
|
||
- A Dagster+ account | ||
- The required [Dagster+ permissions](/todo): | ||
- **Organization Admins** can add, manage, and remove users | ||
- **Admins** can add users | ||
|
||
</details> | ||
|
||
## Before you start | ||
|
||
- **If System for Cross-domain Identity Management specification (SCIM) provisioning is enabled,** you'll need to add new users in your identity provider (IdP). Adding users will be disabled in Dagster+. | ||
Check warning on line 24 in docs/docs-beta/docs/dagster-plus/access/rbac/users.md GitHub Actions / runner / vale
|
||
- **If using Google for Single sign-on (SSO)**, users must be added in Dagster+ before they can log in. | ||
- **If using an Identity Provider (IdP) like Okta for SSO**, users must be assigned to the Dagster app in the IdP to be able to log in to Dagster+. Refer to the [SSO setup guides](/todo) for setup instructions for each of our supported IdP solutions. | ||
|
||
By default, users will be granted Viewer permissions on each deployment. The default role can be adjusted by modifying the [`sso_default_role` deployment setting](/todo). | ||
|
||
## Adding users | ||
|
||
1. Sign in to your Dagster+ account. | ||
2. Click the **user menu (your icon) > Organization Settings**. | ||
3. Click the **Users** tab. | ||
4. Click **Add new user.** | ||
5. In the **User email** field, enter the user's email address. | ||
6. Click **Add user**. | ||
|
||
After the user is created, you can [add the user to teams](#teams) and [assign user roles for each deployment](#user-roles). | ||
|
||
TODO: ADD SCREENSHOT | ||
Check failure on line 41 in docs/docs-beta/docs/dagster-plus/access/rbac/users.md GitHub Actions / runner / vale
Check warning on line 41 in docs/docs-beta/docs/dagster-plus/access/rbac/users.md GitHub Actions / runner / vale
|
||
|
||
## Adding users to teams {#teams} | ||
|
||
:::note | ||
Teams are a Dagster+ Pro feature. | ||
::: | ||
|
||
Teams are useful for centralizing permission sets for different types of users. Refer to [Managing teams](/todo) for more information about creating and managing teams. | ||
|
||
TODO: ADD SCREENSHOT | ||
Check failure on line 51 in docs/docs-beta/docs/dagster-plus/access/rbac/users.md GitHub Actions / runner / vale
|
||
|
||
**Note**: When determining a user's level of access, Dagster+ will use the **most permissive** role assigned to the user between all of their team memberships and any individual role grants. Refer to [Managing user roles and permissions](/todo) for more information. | ||
|
||
## Assigning user roles {#user-roles} | ||
|
||
In the **Roles** section, you can assign a [user role](/todo) for each deployment. | ||
|
||
1. Next to a deployment, click **Edit user role**. | ||
2. Select the user role for the deployment. This [user role](/todo) will be used as the default for all code locations in the deployment. | ||
3. Click **Save**. | ||
4. **Pro only**: To set permissions for individual [code locations](/todo) in a deployment: | ||
1. Click the toggle to the left of the deployment to open a list of code locations. | ||
2. Next to a code location, click **Edit user role**. | ||
3. Select the user role for the code location. | ||
4. Click **Save**. | ||
5. Repeat the previous steps for each deployment. | ||
6. **Optional**: To change the user's permissions for branch deployments: | ||
1. Next to **All branch deployments**, click **Edit user role**. | ||
2. Select the user role to use for all branch deployments. | ||
3. Click **Save**. | ||
7. Click **Done**. | ||
|
||
## Removing users | ||
|
||
Removing a user removes them from the Dagster+ organization. **Note**: If using SSO, you'll also need to remove the user from the IdP. Removing the user in Dagster+ doesn't remove them from the IdP. | ||
|
||
1. Sign in to your Dagster+ account. | ||
2. Click the **user menu (your icon) > Organization Settings**. | ||
3. Click the **Users** tab. | ||
4. Locate the user in the user list. | ||
5. Click **Edit**. | ||
6. Click **Remove user**. | ||
7. When prompted, confirm the removal. | ||
|
||
## Next steps | ||
|
||
- [TODO](/todo) | ||
Check failure on line 88 in docs/docs-beta/docs/dagster-plus/access/rbac/users.md GitHub Actions / runner / vale
|