tractorbeam account
The Tractorbeam API's account operations.
tractorbeam account <subcommand> [flags]
Shared flags
Every subcommand takes these flags.
| Flag | Description |
|---|---|
--config <string> |
The Project’s tractorbeam.config.ts. Defaults to the one in the current directory or its nearest ancestor. |
--workspace <string> |
Workspace name. Environment variable: TRACTORBEAM_WORKSPACE. |
--origin <string> |
The Tractorbeam origin to call instead of the default, such as a proxy’s. Environment variable: TRACTORBEAM_ORIGIN. |
--token <string> |
Access token. Defaults to the saved interactive session. Environment variable: TRACTORBEAM_TOKEN. |
account get
Returns the Account of the Workspace whose host the request addresses, with all its Workspaces. Needs account:manage from a credential whose organization holds one of the Account’s Workspaces. A principal still holding provisioning authority can also read an Account it provisioned, but can’t manage it.
tractorbeam account get [flags]
account invite-manager
Invites an Account manager to the WorkOS organization of the Workspace whose host the request addresses. The invited user’s account:manage permission authorizes that Workspace’s Account; a pending invitation doesn’t grant any authority. Needs account:manage. An email address unable to receive an invitation returns 400.
tractorbeam account invite-manager [flags]
| Flag | Description |
|---|---|
--email <string> |
|
--json <json> |
The body’s fields as one JSON object. Flags given as well override its fields. |