astro workspace token organization-token
astro only
This command is only available on Astro.
Manage Organization-level API tokens within a specific Workspace. See Assign an Organization API token to a Workspace.
There are four sub-commands for managing a Workspace-scoped Organization token.
astro workspace organization-token add
Add an Organization API token to a Workspace and grant it Workspace-specific permissions.
Usage
astro workspace organization-token add --org-token-name=<organization-token-name> --role=<workspace-role>
Options
| Option | Description | Valid Values |
|---|---|---|
-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 Workspace. | One of WORKSPACE_MEMBER, WORKSPACE_AUTHOR, WORKSPACE_OPERATOR or WORKSPACE_OWNER. |
--workspace-id | The Workspace to add the token to. | Any Workspace ID. |
Example
astro workspace organization-token add --org-token-name="My Organization" --role=WORKSPACE_OWNER
astro workspace organization-token list
List all Organization API tokens that are assigned to a specific Workspace.
Usage
astro workspace organization-token list
Options
| Option | Description | Valid Values |
|---|---|---|
--workspace-id | The Workspace to which the API tokens belong. | 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 |
WORKSPACE_ROLE | The API token's role in the Workspace. | 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 workspace organization-token remove
Remove an Organization API token from a Workspace.
Usage
astro workspace organization-token remove
Options
| Option | Description | Valid Values |
|---|---|---|
-n,--org-token-name | The name of the Organization API token you want to remove from the Workspace. | Any string. |
--workspace-id | Workspace where you want to remove an API token. | Any Workspace ID. |
Example
astro workspace organization-token remove
astro workspace organization-token update
Update the role an Organization API token has within a Workspace.
Usage
astro workspace organization-token update --workspace-id=<workspace-id> --role=<workspace-role>
Options
| Option | Description | Valid Values |
|---|---|---|
-n, --org-token-name | The name of the Organization API token you want to update. | Any string. |
-r, --role | The Workspace role that you want to assign to the token. | One of WORKSPACE_MEMBER, WORKSPACE_AUTHOR, WORKSPACE_OPERATOR or WORKSPACE_OWNER. |
--workspace-id | The Workspace where you want to update the token. | Any Workspace ID. |
Example
astro workspace organization-token add --workspace-id=clvdx7z3c000008kv5tdw5tc5 --org-token-name="My organization token" --role=WORKSPACE_AUTHOR