CLI reference

astro team

This command is available only if you’re authenticated to an Astronomer Software installation.

Manage system-level Teams on Astronomer Software. See Import identity provider groups into Astronomer Software.

Usage

This command has several subcommands. Read the following sections to learn how to use each subcommand.

astro team get

View information for a single Team.

Usage

1astro team get <team-id>

You can retrieve a Team’s ID in one of two ways:

  • Access the Team in the Software UI and copy the last part of the URL in your web browser. For example, if your Team is located at BASEDOMAIN.astronomer.io/w/cx897fds98csdcsdafasdot8g7/team/cl4iqjamcnmfgigl4852flfgulye, your Team ID would be cl4iqjamcnmfgigl4852flfgulye.
  • Run astro workspace team list and copy the value in the ID column.

Options

OptionDescriptionPossible Values
-a, --allView all information about the TeamNone
-r, --rolesView role details for the TeamNone
-u, --usersView all users in the TeamNone

astro team list

List all Teams on Astronomer Software.

Usage

1astro team list

Options

OptionDescriptionPossible Values
-a, --allView all information about the TeamNone
-p --paginated Paginate the list of Teams. If --page-size is not specified, the default page size is 20.None
-s --page-sizeThe page size for paginated lists.Any integer

astro team update

Update an Astro Team’s system-level role.

Usage

1astro team update <team-id> --role=<system-role>

You can retrieve a Team’s ID in one of two ways:

  • Access the Team in the Software UI and copy the last part of the URL in your web browser. For example, if your Team is located at BASEDOMAIN.astronomer.io/w/cx897fds98csdcsdafasdot8g7/team/cl4iqjamcnmfgigl4852flfgulye, your Team ID is cl4iqjamcnmfgigl4852flfgulye.
  • Run astro workspace team list and copy the value in the ID column.

Options

OptionDescriptionPossible Values
-r --roleThe Team’s system-level rolePossible values are SYSTEM_VIEWER, SYSTEM_EDITOR, or SYSTEM_ADMIN.