astro deployment token organization-token
astro only
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
astro deployment organization-token add --deployment-id=<my-deployment-id> --role=DEPLOYMENT_ADMIN --workspace-id=<workspace-id>
Options
| Option | Description | Valid Values |
|---|---|---|
--deployment-id | The ID of the Deployment where you want to manage tokens. | Any Deployment ID. |
-n, --org-token-name | The name of the Oganization API token. | Any string. If the name contains a space, specify the entire name within quotes "". |
r, --role | The role the API token has in the Deployment. | DEPLOYMENT_ADMIN or a custom role name. |
--workspace-id | The Workspace to which the Deployment belongs. | Any Workspace ID. |
Example
astro 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
astro deployment organization-token list --deployment-id=<your-deployment-id>
Options
| Option | Description | Valid Values |
|---|---|---|
--deployment-id | The ID of the Deployment to list API tokens for. | Any Deployment ID. |
--workspace-id | The Workspace to which the Deployment belongs. | Any Workspace ID. |
Output
| Output | Description | Data Type |
|---|---|---|
ID | The API token ID. | String |
NAME | The name of the API token. | String |
DESCRIPTION | The API token description. | String |
SCOPE | The original scope of the API token. | String |
DEPLOYMENT_ROLE | The API token's role in the Deployment. | String |
CREATED | How long ago the API token was created, in days. | String |
CREATED BY | The name of the user who created the API token. | String |
astro deployment organization-token remove
Remove an Organization API token from a Deployment.
Usage
astro deployment organization-token remove --deployment-id=<my-deployment-id>
Options
| Option | Description | Valid Values |
|---|---|---|
--deployment-id | The Deployment ID you want to remove an API token from. | Any Deployment ID. |
--org-token-name | The name of the Organization API token you want to remove from the Deployment. | Any string. |
--workspace-id | The Workspace to which the Deployment belongs. | Any Workspace ID. |
Example
astro 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
astro deployment organization-token update --deployment-id=<my-deployment-id> --role=DEPLOYMENT_ADMIN
Options
| Option | Description | Valid Values |
|---|---|---|
--deployment-id | The ID of the Deployment where you want to update an Organization API token. | Any Deployment ID. |
-r, --role | The Deployment role that you want to assign to the token. | DEPLOYMENT_ADMIN or a custom role name. |
-n, --org-token-name | The name of the Organization API token that you want to update. | Any string. |
--workspace-id | The Workspace to which the Deployment belongs. | Any Workspace ID. |
Example
astro deployment organization-token update --deployment-id=clvduhrvd000008l842ohcpvb --org-token-name="My org token" --role=DEPLOYMENT_ADMIN