tw participants
Run tw participants -h to view supported participant operations.
Manage workspace participants.
The operations listed below require workspace OWNER or ADMIN permissions.
tw participants list
List workspace participants.
tw participants list [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-t, --type | Participant type to list (MEMBER, TEAM, COLLABORATOR). | No | null |
-f, --filter | Show only participants that it's name starts with the given word. | No | null |
-w, --workspace | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable) | Yes | TOWER_WORKSPACE_ID |
--page | Page number for paginated results (default: 1) | No | null |
--offset | Row offset for paginated results (default: 0) | No | null |
--max | Maximum number of records to display (default: ) | No | null |
Example
Command:
tw participants list
Example output:
Participants for 'my-tower-org/shared-workspace' workspace:
ID | Participant Type | Name | Workspace Role
----------------+------------------+-----------------------------+----------------
45678460861822 | MEMBER | user (user@mydomain.com) | owner
tw participants add
Add a workspace participant.
tw participants add [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-n, --name | Team name, username or email for existing organization member. | Yes | null |
-t, --type | Type of participant (MEMBER, COLLABORATOR or TEAM). | Yes | null |
--overwrite | Overwrite the participant if it already exists. | No | false |
-w, --workspace | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable) | Yes | TOWER_WORKSPACE_ID |
Run tw participants add -h to view the required and optional fields for adding a participant.
To add a new participant to the workspace, use the add subcommand. When adding a COLLABORATOR type participant, the default role assigned is Launch. For MEMBER type participants, you can specify organization members who will have access to the workspace.
See Participant roles for more information.
Example
Command:
tw participants add --name=collaborator@mydomain.com --type=COLLABORATOR -w 123456789012345
Example output:
User 'collaborator@mydomain.com' was added as participant to [my-organization / my-workspace] workspace with role 'launch'
tw participants update
Update a participant role.
tw participants update [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-n, --name | Team name, username or email for existing organization member. | Yes | null |
-t, --type | Type of participant (MEMBER, COLLABORATOR or TEAM). | Yes | null |
-r, --role | Workspace participant role (OWNER, ADMIN, MAINTAIN, LAUNCH, CONNECT or VIEW). | Yes | null |
-w, --workspace | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable) | Yes | TOWER_WORKSPACE_ID |
To update the role of a Collaborator to ADMIN or MAINTAIN, use the update subcommand:
Example
Command:
tw participants update --name=collaborator@mydomain.com --type=COLLABORATOR --role=MAINTAIN
Example output:
Participant 'collaborator@mydomain.com' has now role 'maintain' for workspace 'shared-workspace'
tw participants delete
Remove a workspace participant.
tw participants delete [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-n, --name | Team name, username or email for existing organization member. | Yes | null |
-t, --type | Type of participant (MEMBER, COLLABORATOR or TEAM). | Yes | null |
-w, --workspace | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable) | Yes | TOWER_WORKSPACE_ID |
Example
Command:
tw participants delete -n user2-name -t MEMBER -w 123456789012345
Example output:
Participant 'user2-name' was removed from 'my-workspace' workspace
Requires participant name, type, and workspace ID.
tw participants leave
Leave a workspace.
tw participants leave [OPTIONS]
Options
| Option | Description | Required | Default |
|---|---|---|---|
-w, --workspace | Workspace numeric identifier or reference in OrganizationName/WorkspaceName format (defaults to TOWER_WORKSPACE_ID environment variable) | Yes | TOWER_WORKSPACE_ID |
Example
Command:
tw participants leave -w organization5/test-workspace
Example output:
You have been removed as a participant from 'test-workspace' workspace