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.

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

[docs-beta] migrate - dagster+ tokens #26608

Merged
merged 3 commits into from
Dec 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,51 @@ sidebar_position: 200
unlisted: true
---

{/* TODO move agent token content from https://docs.dagster.io/dagster-plus/account/managing-user-agent-tokens */}
# Managing agent tokens in Dagster+

:::note
This guide is applicable to Dagster+.
:::

In this guide, we'll walk you through creating and revoking agent tokens in Dagster+.

## Managing agent tokens
:::note
{/* /dagster-plus/account/managing-users */}
To manage agent tokens, you need to be an [Organization Admin](/todo.md) in
Dagster+.
:::

{/* /dagster-plus/deployment/agents */}
Agent tokens are used to authenticate [Hybrid agents](/todo.md) with the Dagster+ Agents API.

### Creating agent tokens

1. Sign in to your Dagster+ account.
2. Click the **user menu (your icon) > Organization Settings**.
3. Click the **Tokens** tab.
4. Click **+ Create agent token**.

After the token is created:

- **To view a token**, click **Reveal token**. Clicking on the token value will copy it to the clipboard.
- **To edit a token's description**, click the **pencil icon**.

### Assigning agent token permissions

1. Sign in to your Dagster+ account.
2. Click the **user menu (your icon) > Organization Settings**.
3. Click the **Tokens** tab.
4. Click **Edit** next to the agent token you'd like to change.

The permissions dialog allows you to edit a token's ability to access certain deployments. By default, agent tokens have permission to access any deployment in the organization including branch deployments. This is called **Org Agent** and is set using the toggle in the top right of the dialog. To edit individual deployment permissions, **Org Agent** has to first be toggled off.

### Revoking agent tokens

To revoke a token:

1. Sign in to your Dagster+ account.
2. Click the **user menu (your icon) > Organization Settings**.
3. Click the **Tokens** tab.
4. Click **Edit** next to the agent token you'd like to change.
5. Click **Revoke** in the bottom left of the permissions dialog. When prompted, confirm to proceed with revoking the token.
Original file line number Diff line number Diff line change
@@ -1,7 +1,41 @@
---
title: User tokens
title: 'User tokens'
sidebar_position: 100
unlisted: true
---

{/* TODO move user token content from https://docs.dagster.io/dagster-plus/account/managing-user-agent-tokens */}
import ThemedImage from '@theme/ThemedImage';

# Managing user tokens in Dagster+

:::note
This guide is applicable to Dagster+.
:::

In this guide, we'll walk you through creating user tokens in Dagster+.

## Managing user tokens
1. Sign in to your Dagster+ account.
2. Click the **user menu (your icon) > Organization Settings**.
3. Click the **Tokens** tab.
4. Click **+ Create user token**.

After the token is created:

- **To edit a token's description**, click the **pencil icon**.
- **To view a token**, click **Reveal token**. Clicking on the token value will copy it to the clipboard.
- **To revoke a token**, click **Revoke**.

To manage tokens for another user, select the user from the **Manage tokens for** dropdown:

dehume marked this conversation as resolved.
Show resolved Hide resolved
<ThemedImage
style={{width:'100%', height: 'auto'}}
sources={{
light: '/images/dagster-plus/user-token-management/manage-user-tokens-for.png',
dark: '/images/dagster-plus/user-token-management/manage-user-tokens-for.png',
}}
/>

:::note
**Organization Admin** permissions are required to manage another user's tokens.
:::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading