Skip to main content
workspace は、ロールを割り当てた他の Square Cloud ユーザーとアプリを共有する仕組みです。client.workspaces は workspace を、client.workspaces.members はそのメンバーを、client.workspaces.apps は共有アプリを管理します。 workspace の作成には Standard、Pro、Enterprise のいずれかのプランが必要です。 サンプルでは、クライアントの作成で作成した client を使います。workspace_id は workspace の ID (workspaces.list() で一覧できます)、app_id はあなたのアプリの ID、member_id はメンバーの id です。

Workspace

所有者は退出できません (400 CANNOT_LEAVE_OWNER)。代わりに workspace を削除してください。

メンバー

メンバーを追加するには、そのメンバーが members.invite_code() で生成する招待コードが必要です。コードは 5 分間有効です。
ロール (group): view、manager、maintain、admin。自分のロールで許可されていないメソッドを呼び出すと 403 PERMISSION_DENIED になります。

共有アプリケーション

1 つの workspace には最大 100 個のアプリを追加できます (400 APPLICATIONS_LIMIT_REACHED)。

共有アプリの操作

自分と共有されたアプリを操作するには、任意の client.apps メソッドに複合 ID <appId>-<workspaceId> を渡します。workspaces.get() と workspaces.list() は素の ID を返すので、自分で組み立ててください:

エラー

workspace のルートは ID をリクエストボディで送信するため、空の ID はサーバーから返される 400 INVALID_ID になります (ローカルのエラーではありません)。例外は workspaces.get() で、その ID は URL パスに含まれるため、空の ID はローカルで失敗します。

次のステップ

AI

AI Gateway を通じたチャット補完。

Workspace API リファレンス

これらのメソッドが呼び出す REST endpoint。

CLI で workspace を操作

同じ操作をターミナルから行います。