CLI referenceastro deploymentastro deployment token

astro deployment token organization-token

This command is only available on Astro.

Manage Organization-level API tokens within a specific Deployment. See Assign an Organization or Workspace API token to a Deployment.

astro deployment organization-token add

Add an Organization API token to a Deployment and grant it Deployment-specific permissions.

Usage

1astro deployment organization-token add --deployment-id=<my-deployment-id> --role=DEPLOYMENT_ADMIN --workspace-id=<workspace-id>

Options

OptionDescriptionValid Values
--deployment-idThe ID of the Deployment where you want to manage tokens.Any Deployment ID.
-n, --org-token-nameThe name of the Oganization API token.Any string. If the name contains a space, specify the entire name within quotes "".
r, --roleThe role the API token has in the Deployment.DEPLOYMENT_ADMIN or a custom role name.
--workspace-idThe Workspace to which the Deployment belongs.Any Workspace ID.

Example

1astro deployment organization-token add --deployment-id=clvduhrvd000008l842ohcpvb --role=DEPLOYMENT_ADMIN --org-token-name="My org token"

astro deployment organization-token list

List all Organization API tokens that are assigned to a specific Deployment.

Usage

1astro deployment organization-token list --deployment-id=<your-deployment-id>

Options

OptionDescriptionValid Values
--deployment-idThe ID of the Deployment to list API tokens for.Any Deployment ID.
--workspace-idThe Workspace to which the Deployment belongs.Any Workspace ID.

Output

OutputDescriptionData Type
IDThe API token ID.String
NAMEThe name of the API token.String
DESCRIPTIONThe API token description.String
SCOPEThe original scope of the API token.String
DEPLOYMENT_ROLEThe API token’s role in the Deployment.String
CREATEDHow long ago the API token was created, in days.String
CREATED BYThe name of the user who created the API token.String

astro deployment organization-token remove

Remove an Organization API token from a Deployment.

Usage

1astro deployment organization-token remove --deployment-id=<my-deployment-id>

Options

OptionDescriptionValid Values
--deployment-idThe Deployment ID you want to remove an API token from.Any Deployment ID.
--org-token-nameThe name of the Organization API token you want to remove from the Deployment.Any string.
--workspace-idThe Workspace to which the Deployment belongs.Any Workspace ID.

Example

1astro deployment organization-token remove --deployment-id=clvduhrvd000008l842ohcpvb --org-token-name="My org token"

astro deployment organization-token update

Update the role an Organization API token has within a Deployment.

Usage

1astro deployment organization-token update --deployment-id=<my-deployment-id> --role=DEPLOYMENT_ADMIN

Options

OptionDescriptionValid Values
--deployment-idThe ID of the Deployment where you want to update an Organization API token.Any Deployment ID.
-r, --roleThe Deployment role that you want to assign to the token.DEPLOYMENT_ADMIN or a custom role name.
-n, --org-token-nameThe name of the Organization API token that you want to update.Any string.
--workspace-idThe Workspace to which the Deployment belongs.Any Workspace ID.

Example

1astro deployment organization-token update --deployment-id=clvduhrvd000008l842ohcpvb --org-token-name="My org token" --role=DEPLOYMENT_ADMIN