CLI referenceastro workspace

astro workspace service-account

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

Usage

This command has several subcommands.

astro workspace service-account create

Creates a service account for a given Workspace.

Usage

1astro workspace service-account create --workspace-id=<your-workspace> --label=<your-label>

Options

OptionDescriptionPossible Values
--workspace-id (Required)The Workspace you’re creating a service account for.Any valid Workspace ID
--label (Required)A label for the service account.Any string
--categoryThe Category for the service account. The default is Not set.Any string
roleThe User Role for the service account.Possible values are WORKSPACE_VIEWER, WORKSPACE_EDITOR, WORKSPACE_ADMIN. The default value is WORKSPACE_VIEWER.

astro workspace service-account delete

Deletes a service account for a given Workspace.

Usage

1astro workspace service-account delete <your-service-account-id>

Options

OptionDescriptionPossible Values
--workspace-idThe Workspace in which you want to delete a service account. If this flag is used instead of specifying <your-service-account-id>, you’ll be prompted to select a service account from a list of all service accounts on the Workspace.Any valid Workspace ID

astro workspace service-account get

Shows the name, ID, and API token for each service account on a given Workspace.

Usage

Run astro deployment service-account get <service-account-id> --workspace-id=<your-workspace-id> to get information on a single service account within a Workspace. To see a list of all service accounts on a Workspace, run astro deployment service-account get --workspace-id=<your-workspace-id>.

Options

OptionDescriptionPossible Values
--workspace-idThe Workspace you’re getting the service account from. Use this flag as an alternative to specifying <your-service-account-id>.Any valid Workspace ID