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 OwnersOrganization Owners can also add or update a user or Team for a Workspace from your Organization’s access management settings:
- New Astro UI
- Legacy UI
- In the Astro UI, go to Settings, then in the Access Management section, click Users or Teams.
- Select the user or Team.
- 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
- New Astro UI
- Legacy UI
- In the Astro UI, go to Settings > Workspaces.
- Select your Workspace, then in the Access Management section, click Users.
- Click + Add User.
- In the User field, enter the email address of the user you want to invite.
- From the dropdown, select the Invite new user option for the email you entered.
- Choose a Workspace Role. See Workspace roles reference.
- Click Invite User to Workspace.
Update or remove a Workspace user
- New Astro UI
- Legacy UI
- In the Astro UI, go to Settings > Workspaces.
- Select your Workspace, then in the Access Management section, click Users.
- To edit the user’s role, click the user’s More actions menu (⋯), select Edit User, change their access type, then click Update User.
- 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.-
Create a text file named
users.txt. -
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:
-
Create a file named
add-users.shand add the following script to it:add-users.sh -
Log in to the Astro CLI using
astro login, then runastro workspace listto ensure that you’re in the same Workspace where you want to add the users. If you’re not in the right Workspace, runastro workspace switch. -
Run the following command to execute the shell script:
-
(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.