Skip to main content

​
WorkOS Command Guide (si orbit workos)

WorkOS si orbit workos provides WorkOS operational APIs with account context and environment-aware auth.

​
Command surface

si orbit workos <auth|context|doctor|organization|user|membership|invitation|directory|raw>

​
Auth and context

si orbit workos auth status --account core --env prod --json
si orbit workos context list --json
si orbit workos context current --json
si orbit workos context use --account core --env prod --org-id org_123
si orbit workos doctor --account core --env prod --public --json

​
Organization and user management

si orbit workos organization list --json
si orbit workos organization get org_123 --json
si orbit workos organization create --name "Aureuma" --json

si orbit workos user list --json
si orbit workos user get user_123 --json
si orbit workos user create --email admin@example.com --first-name Admin --last-name User --json

​
Memberships, invitations, directories

si orbit workos membership list --organization-id org_123 --json
si orbit workos membership create --organization-id org_123 --user-id user_123 --role admin --json

si orbit workos invitation list --organization-id org_123 --json
si orbit workos invitation create --organization-id org_123 --email ops@example.com --role member --json

si orbit workos directory list --json
si orbit workos directory get dir_123 --json

​
Raw API mode

si orbit workos raw --method GET --path /organizations --json
si orbit workos raw --method POST --path /organizations --json-body '{"name":"Aureuma"}' --json

​
Safety guidance

  • Use environment-specific contexts (prod|staging|dev) for separation.
  • Validate organization IDs before membership/invitation writes.
  • Prefer JSON output in CI pipelines.
  • Keep WorkOS keys in vault-managed env refs.

​
Troubleshooting

  1. si orbit workos auth status --json
  2. si orbit workos doctor --json
  3. si orbit list --provider workos --json
  4. Validate selected env/account and key source.