邀请 workspace 成员
使用邀请码向 workspace 添加成员(POST /v2/workspaces/members),并分配角色:view、manager、maintain 或 admin。仅限所有者。
POST
/
v2
/
workspaces
/
members
邀请 workspace 成员
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 拥有者在成员列表中显示为
workspaces:manage 权限范围的 API 密钥。
使用获取邀请码生成的短期邀请码将成员添加到 workspace 中:被邀请的用户由邀请码标识,调用者通过 group 分配其角色。只有 workspace 拥有者可以调用此端点,且 workspace 的成员数量上限由拥有者的套餐等级决定。
group 中的角色决定成员可以对 workspace 共享应用执行哪些操作:参见角色。之后可使用修改权限更改角色。拥有者不能邀请自己。速率限制为每个用户每 5 秒 1 次添加操作。
角色
控制台按名称显示每个角色,API 则接收group 列中的值。
| 控制台 | group | 成员可以对 workspace 共享应用执行的操作 |
|---|---|---|
| View | view | 只读:信息、状态、日志、指标、网络分析和部署历史。 |
| Manager | manager | view 的全部权限,外加启动、停止和重启,以及查看当前部署设置。 |
| Maintain | maintain | view 的全部权限,外加启动、停止和重启、提交、文件、DNS 记录和缓存清除。 |
| Admin | admin | 全部权限,包括环境变量、快照、自定义域名、GitHub webhook,以及 .env 等受限文件。 |
group: "owner",并始终拥有完整权限。owner 无法被分配。
参数
string
必填
workspace 的 ID。
string
必填
包含成员邀请码的字符串。
响应
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 不存在。 |
相关内容
- CLI:
squarecloud workspace member add - SDK:
api.workspaces.members.add()(JavaScript)、client.workspaces.members.add()(Python)、c.Workspaces.Members.Add()(Go)
⌘I
邀请 workspace 成员
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"
}

