workspace の招待コード取得
GET /v2/workspaces/members/code で 1 回限りの招待コードを生成し、workspace のオーナーに渡して追加してもらいます。コードは 5 分で失効します。
GET
workspace の招待コード取得
workspaces:manage スコープを持つ API キーが必要です。
特定のworkspaceにではなく、認証済みユーザー本人に紐づく短命の招待コードを生成します。参加したいユーザーはこのコードをチャットやメールなどの手段でworkspaceオーナーに伝え、オーナーは付与するロールとともにメンバーの招待でこのコードを送信します。
コードは生成から5分で失効し、1回限り使用可能です。使用された時点で無効になります。オーナーに追加してもらう前に失効した場合は、新しいコードをリクエストしてください。レート制限は1ユーザーあたり5分間に1回のコード生成です。
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。string
あなたの workspace 招待コード。
一般的なエラー
関連項目
- CLI:
squarecloud workspace member invite-code - SDK:
api.workspaces.members.inviteCode()(JavaScript),client.workspaces.members.invite_code()(Python),c.Workspaces.Members.InviteCode()(Go)

