​

organization

orc organization は、所属するOrganizationを一覧にし、CLIの操作対象を切り替え、組織設定・メンバー・招待を管理するコマンドです。組織名やBrand / Agency設定を変更し、メンバーの組織ロールを更新し、招待の送信と取り消しを行えます。

実行前に orc auth login で認証してください。組織を切り替えるには、切替先への所属と、利用できるWorkspaceが必要です。API keyは認証された組織の範囲で使用します。本人の表示名を変更する場合は orc profile を使用してください。

use はCLIの選択を保存します。現在のWorkspaceが切替先に属していれば維持し、属していなければ切替先で利用できるWorkspaceを選択します。切替先に属していないディレクトリのWorkspaceリンクは解除されます。

所属する組織のID、名前、組織ロールを一覧にします。

organization use には organization list の組織IDを指定します。組織名やslugでは指定できません。IDを省略した対話式の選択はありません。

組織を切り替え、組織とWorkspaceの選択結果を確認します。

切り替えでは、所属組織と利用可能なWorkspaceを取得し、選択したWorkspaceをAPIで検証してから現在のCLIプロファイルに保存します。切替先で利用できるWorkspaceがなければ、選択を変更せずエラーを返します。別のWorkspaceを選ぶ場合は orc workspace の list と use を使用してください。

同じ組織内でWorkspaceを選び、必要に応じて現在のディレクトリに関連付けます。

Workspaceの解決順は、--workspace、ORCHESTOR_WORKSPACE_ID、ディレクトリのリンク、保存した既定値です。1回のAPI操作だけ対象を指定する場合は --workspace <workspace-id> を使用します。組織切替で、切替先に属していないディレクトリのリンクは解除されます。切替先と異なる ORCHESTOR_WORKSPACE_ID が設定されている場合は、環境変数を解除してから再実行してください。

組織IDを指定してCLIの選択を保存します。切替先に属する現在のWorkspaceは維持し、属していなければ利用可能なWorkspaceを選択します。所属確認とAPIでの検証に成功するまで保存しません。

組織IDを指定してCLIの選択を保存します。

現在のWorkspaceから解決された組織の設定と本人の組織ロールを表示します。組織名、organization_type、slug、website_url、member_countを確認できます。

現在のWorkspaceから解決された組織の設定と本人の組織ロールを表示します。

組織のname、type、slug、website_urlを更新します。typeはbrandまたはagencyです。省略した項目は保持し、website_urlはnullで解除できます。typeと互換フィールドorganization_typeは同時に指定しないでください。

Body field: name

型: string。任意。

Body field: slug

型: string。任意。

Body field: organization_type; enum: brand|agency

型: string。任意。

The agency Organization's own website URL. Brand Organizations may leave this null because the managed brand URL belongs to Workspace setup.; (use "null" or "reset" to clear)

型: string。任意。

Body field: type; enum: brand|agency

型: string。任意。

組織のname、type、slug、website_urlを更新します。

現在の組織の招待ID、宛先、org_role、workspace_assignments、有効期限と状態を一覧にします。--stateはpending、accepted、expired、revokedで絞り込みます。次のページは応答のnext_cursorを--cursorに渡し、--limitで1ページの件数を指定します。

enum: pending|accepted|expired|revoked

型: string。任意。

現在の組織の招待ID、宛先、org_role、workspace_assignments、有効期限と状態を一覧にします。

本文にemailとroleを指定して1人を招待します。roleはowner、admin、memberです。互換フィールドorg_roleも使用できますが、roleと異なる値を同時に指定できません。ownerを招待できるのはownerです。既存メンバーや有効な招待がある宛先は拒否されます。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

(required) Body field: email; max 255 chars

型: string。任意。

Body field: org_role; enum: owner|admin|member

型: string。任意。

Body field: workspace_assignments; JSON array of objects (use --stdin for large resources)

型: string。任意。

Body field: role; enum: owner|admin|member

型: string。任意。

本文にemailとroleを指定して1人を招待します。

invites listの招待IDを指定してpendingの招待を取り消します。accepted、expired、revokedの招待は取り消せません。承諾済みのメンバーを除外するにはmembers deleteを使用します。

invites listの招待IDを指定してpendingの招待を取り消します。

所属する組織のID、名前、組織ロールを一覧にします。人のアカウントでは有効な所属だけを返し、API keyでは認証された組織の範囲を返します。

所属する組織のID、名前、組織ロールを一覧にします。

現在の組織に有効な所属を持つメンバーのuser_id、first_name、last_name、roleを一覧にします。Workspace内だけの一覧ではありません。

現在の組織に有効な所属を持つメンバーのuser_id、first_name、last_name、roleを一覧にします。

members listのuser_idと、本文のroleを指定して組織ロールを変更します。roleはowner、admin、memberです。ownerを管理できるのはownerで、最後のownerの降格は拒否されます。

(required) Body field: role; enum: owner|admin|member

型: string。任意。

members listのuser_idと、本文のroleを指定して組織ロールを変更します。

現在の組織への所属と、それに紐付くWorkspaceアクセスを除外します。アカウント自体は削除しません。ownerの除外はownerだけが実行でき、最後のownerは除外できません。実行時に対象の確認があります。

現在の組織への所属と、それに紐付くWorkspaceアクセスを除外します。

list の id は use に渡す組織IDです。current の workos_organization_id も同じ組織識別子を示します。

組織と現在の操作対象を確認します。

name と type は省略した項目を保持します。type は brand または agency です。

組織設定の更新本文を用意します。

更新の --dry-run はリクエストのプレビューを表示し、更新APIを呼び出しません。サーバーでの権限確認の成功を保証するものではありません。

組織設定のリクエストを確認してから更新します。

組織ロールは owner、admin、member です。Workspaceロールとは別の設定です。

組織ロールを変更する本文を用意します。

members list の user_id を指定します。Workspace member IDや招待IDは使用しません。

メンバー一覧からuser IDを確認してロールを変更します。

1回の操作で1人を招待します。組織ロールの付与と、Workspaceへのアクセス割り当ては別の指定です。

招待する宛先と組織ロールを指定します。

既存メンバーや有効な招待がある宛先への作成は拒否されます。成功した招待のID、状態、期限はAPIの応答で確認します。

招待を作成し、未承諾の招待を確認します。

組織ロールには owner、admin、member を使用します。owner を招待・変更・除外できるのは組織の owner です。admin は member と admin を管理できますが、owner を付与したり管理したりできません。最後の組織 owner の降格・除外は拒否されます。

members delete はその組織への所属を除外し、その所属に紐付くWorkspaceアクセスも無効にします。アカウントそのものや他の組織への所属は削除しません。招待の workspace_assignments を使用する場合、各要素に workspace_id と workspace_role を指定します。Workspaceロールは owner または member で、別の組織のWorkspaceは割り当てられません。

組織への招待と、同じ組織のWorkspaceへのアクセスを指定します。

一覧・現在の組織・メンバー一覧は認証済みの所属範囲で参照します。組織設定の更新には組織の owner または admin と workspace:settings 権限、招待操作には組織の owner または admin と workspace:invite 権限が必要です。メンバーの更新・除外には組織の owner または admin が必要です。Workspaceの owner であっても、組織管理権限が自動的に付与されるわけではありません。

orc organization では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。

organization list の id を指定していることと、切替先で利用できるWorkspaceがあることを確認します。ORCHESTOR_WORKSPACE_ID が別の組織を指定している場合は解除してください。API keyの組織範囲を超えて切り替えることはできません。人のアカウントでログインし、再度実行してください。

organization current の role を確認します。Workspaceの管理権限と組織の管理権限は別です。admin からの owner 付与、owner の管理、最後の owner の除外は拒否されます。メンバーの指定には members list の user_id を使用してください。

宛先が既存メンバーである場合や、有効な招待が残っている場合は重複する招待を作成できません。invites list --state pending で状態を確認してください。取り消せるのは pending の招待です。承諾済みのメンバーを除外するには members delete を使用します。

DELETE操作には確認が必要です。自動実行では対象IDと組織を確認し、--yes を指定します。まず --dry-run で対象リクエストを確認できます。