AdministrationUser access

Manage users in your Astro Workspace

As a Workspace Owner or an Organization Owner, you can add new team members to Astro and grant them user roles with permissions for specific actions across your Workspace.

To manage users at the Organization level, see Manage Organization users. To manage groups of users, see Manage Teams.

A new Astro UI is here

Astronomer has redesigned the Astro UI. Try the new experience and switch your instructions using the New Astro UI and Legacy UI tabs on this page. Your selection is remembered across the docs.

Prerequisites

To add, edit, or remove Workspace users from a given Workspace, you need either Organization Owner permissions or Workspace Owner permissions for the Workspace.

Centralized access management for Organization Owners

Organization Owners can also add or update a user or Team for a Workspace from your Organization’s access management settings:

  1. In the Astro UI, go to Settings, then in the Access Management section, click Users or Teams.
  2. Select the user or Team.
  3. Click the Workspaces tab, then click + Add Workspace to add them to a Workspace, or Edit Role to change their role for an existing Workspace.

Add a user to a Workspace

  1. In the Astro UI, go to Settings > Workspaces.
  2. Select your Workspace, then in the Access Management section, click Users.
  3. Click + Add User.
  4. In the User field, enter the email address of the user you want to invite.
  5. From the dropdown, select the Invite new user option for the email you entered.
  6. Choose a Workspace Role. See Workspace roles reference.
  7. Click Invite User to Workspace.

After you add the user, their information appears in the Users tab as a new entry in the Members list.

You can also add groups of users to a Workspace through Teams. See Manage Teams.

Update or remove a Workspace user

  1. In the Astro UI, go to Settings > Workspaces.
  2. Select your Workspace, then in the Access Management section, click Users.
  3. To edit the user’s role, click the user’s More actions menu (⋯), select Edit User, change their access type, then click Update User.
  4. To remove the user, click the user’s More actions menu (⋯), select Remove User…, then click Yes, Continue.

Add a group of users to a Workspace using the Astro CLI

You can use the Astro CLI and a shell script to add multiple users to a Workspace at once. The shell script reads from a text file which contains user information. You can generate a text file for each new batch of users that need to be assigned to a Workspace and run the script with the Astro CLI.

  1. Create a text file named users.txt.

  2. Open the text file. On each line, add a user’s email and their role separated by a space. The following is an example of how you can write a list for inviting users to a Workspace:

    user1@astronomer.io WORKSPACE_MEMBER
    user2@astronomer.io WORKSPACE_OWNER
    user3@astronomer.io WORKSPACE_OPERATOR
    user4@astronomer.io WORKSPACE_OWNER

  3. Create a file named add-users.sh and add the following script to it:

    add-users.sh
    $#!/bin/bash
    $
    $# Check if a file was provided as an argument
    $if [ $# -ne 1 ]; then
    $    echo "Usage: $0 <file>"
    $    exit 1
    $fi
    $
    $while read line; do
    $    email=$(echo "$line" | cut -d' ' -f1)
    $    role=$(echo "$line" | cut -d' ' -f2)
    $    echo "Inviting $email as $role..."
    $    astro workspace user add "$email" --role "$role"
    $done < "$1"

  4. Log in to the Astro CLI using astro login, then run astro workspace list to ensure that you’re in the same Workspace where you want to add the users. If you’re not in the right Workspace, run astro workspace switch.

  5. Run the following command to execute the shell script:

    1sh path/to/add-users.sh path/to/users.txt

  6. (Optional) To use this script as part of a CI/CD pipeline, create an Organization API token or Workspace API token and specify the environment variable ASTRO_API_TOKEN=<your-token> in your CI/CD environment. Note that you can use Workspace API tokens to manage users only at the Workspace level.

See also