Skip to main content
POST
メンバーの招待
string
必須
アカウントの API キーです。これはアカウント設定で確認できます。
招待コードの取得で発行された短命のコードを使ってworkspaceにメンバーを追加します。招待されたユーザーはコードによって識別され、呼び出し元は group でそのロールを割り当てます。呼び出せるのはworkspaceオーナーのみで、workspaceのメンバー数はオーナーのプラン階層によって上限が決まります。 割り当て可能な4つのロールは、メンバーがworkspaceの共有アプリケーションに対して行える操作を制御します。view は読み取り専用、manager はアプリの操作(起動・停止・再起動)とデプロイ情報の閲覧が可能ですがコミットやファイル操作はできません、maintain はファイル管理・DNS・キャッシュのパージ・コミットが追加され、admin は環境変数・スナップショット・カスタムドメイン・デプロイWebhookが追加されます。ロールは後から権限の変更で変更できます。オーナーは自分自身を招待できません。レート制限は1ユーザーあたり5秒間に1回の追加です。

パラメーター

string
workspace の ID。
string
メンバー招待コードの文字列。
string
workspace のアプリケーションに対するメンバーの権限

レスポンス

string
呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。

一般的なエラー