ワークスペース - メンバー
メンバーの招待
workspace に誰かを招待します。
POST
/
v2
/
workspaces
/
members
メンバーの招待
curl --request POST \
--url https://api.squarecloud.app/v2/workspaces/members \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"code": "<string>",
"group": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/workspaces/members"
payload = {
"workspaceId": "<string>",
"code": "<string>",
"group": "<string>"
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({workspaceId: '<string>', code: '<string>', group: '<string>'})
};
fetch('https://api.squarecloud.app/v2/workspaces/members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => '<string>',
'code' => '<string>',
'group' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/workspaces/members"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"code\": \"<string>\",\n \"group\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/workspaces/members")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"code\": \"<string>\",\n \"group\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/workspaces/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"code\": \"<string>\",\n \"group\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success"
}
招待コードの取得で発行された短命のコードを使ってworkspaceにメンバーを追加します。招待されたユーザーはコードによって識別され、呼び出し元は
group でそのロールを割り当てます。呼び出せるのはworkspaceオーナーのみで、workspaceのメンバー数はオーナーのプラン階層によって上限が決まります。
割り当て可能な4つのロールは、メンバーがworkspaceの共有アプリケーションに対して行える操作を制御します。view は読み取り専用、manager はアプリの操作(起動・停止・再起動)とデプロイ情報の閲覧が可能ですがコミットやファイル操作はできません、maintain はファイル管理・DNS・キャッシュのパージ・コミットが追加され、admin は環境変数・スナップショット・カスタムドメイン・デプロイWebhookが追加されます。ロールは後から権限の変更で変更できます。オーナーは自分自身を招待できません。レート制限は1ユーザーあたり5秒間に1回の追加です。
パラメーター
string
workspace の ID。
string
メンバー招待コードの文字列。
string
workspace のアプリケーションに対するメンバーの権限
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。{
"status": "success"
}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
INVALID_ID | 400 | workspaceId が指定されていません。 |
INVALID_CODE | 400 | 招待コードが指定されていない、形式が不正、または期限切れです。 |
CANNOT_INVITE_OWNER | 400 | 招待コードが呼び出し元のものであり、すでにworkspaceを所有しています。 |
INVALID_GROUP | 400 | group が view、manager、maintain、admin のいずれでもありません。 |
MEMBERS_LIMIT_REACHED | 400 | workspaceがすでにプランの上限数のメンバーに達しています。 |
MEMBER_ALREADY_ADDED | 400 | 招待されたユーザーはすでにこのworkspaceのメンバーです。 |
WORKSPACE_NOT_FOUND | 404 | workspaceが存在しません。 |
⌘I
メンバーの招待
curl --request POST \
--url https://api.squarecloud.app/v2/workspaces/members \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"code": "<string>",
"group": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/workspaces/members"
payload = {
"workspaceId": "<string>",
"code": "<string>",
"group": "<string>"
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({workspaceId: '<string>', code: '<string>', group: '<string>'})
};
fetch('https://api.squarecloud.app/v2/workspaces/members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => '<string>',
'code' => '<string>',
'group' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/workspaces/members"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"code\": \"<string>\",\n \"group\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/workspaces/members")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"code\": \"<string>\",\n \"group\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/workspaces/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"code\": \"<string>\",\n \"group\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success"
}

