跳过内容

成员

组织成员是有权访问您的Capgo组织的用户。每个成员都有特定的角色,决定了他们在组织中的权限。有效管理成员对于维护团队的安全和协作至关重要。

成员角色

成员角色部分
  • read: 可以查看资源,但不能进行修改
  • upload: 可以上传新包并查看资源
  • write: 可以修改资源并上传包
  • admin: 可以管理组织设置和成员
  • super_admin: 对组织有完全控制权
  • invite_read: 等待读取访问邀请
  • invite_upload: 等待上传访问邀请
  • invite_write: 等待写入访问邀请
  • invite_admin: 等待管理员访问邀请
  • invite_super_admin: 等待超级管理员访问邀请
  1. 角色分配: 分配角色时遵循最小特权原则
  2. 常规审计: 定期审查成员访问权限并删除未使用的账户
  3. 入职: 为添加新成员和分配角色建立明确的流程
  4. 离职: 及时移除离开组织的成员的访问权限

POST

POST

https://api.capgo.app/organization/members/

添加一个新成员到一个组织或更新一个现有成员的角色。请注意,您只能邀请已经有一个Capgo账户的用户 - 邮件必须对应一个现有的Capgo用户。

Request Body

Request Body
interface MemberCreate {
orgId: string
email: string
role: "read" | "upload" | "write" | "admin" | "super_admin"
}

示例请求

终端窗口
复制到剪贴板
curl -X POST \
-H "authorization: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"orgId": "org_123",
"email": "newmember@example.com",
"role": "write"
}' \
https://api.capgo.app/organization/members/
{
"status": "OK",
"data": {
"uid": "user_789",
"email": "newmember@example.com",
"role": "invite_write",
"image_url": null
}
}

注意:

  • 添加新成员时,他们会收到邀请邮件。直到他们接受邀请,成员角色前缀为“invite_”。
  • 用户必须在添加成员之前拥有一个Capgo账户。如果他们没有账户,请首先在 https://console.capgo.app/register/

https://api.capgo.app/organization/members/

请求参数

复制到剪贴板

响应类型
interface MemberQuery {
orgId: string
}

Section titled “Query Parameters”

Section titled “Response Type”
interface Member {
uid: string;
email: string;
image_url: string;
role: "invite_read" | "invite_upload" | "invite_write" | "invite_admin" | "invite_super_admin" | "read" | "upload" | "write" | "admin" | "super_admin";
}
终端窗口
curl -H "authorization: your-api-key" \
"https://api.capgo.app/organization/members/?orgId=org_123"
{
"data": [
{
"uid": "user_123",
"email": "john@example.com",
"image_url": "https://example.com/avatar.png",
"role": "admin"
},
{
"uid": "user_456",
"email": "jane@example.com",
"image_url": "https://example.com/avatar2.png",
"role": "write"
},
{
"uid": "user_789",
"email": "bob@example.com",
"image_url": null,
"role": "invite_read"
}
]
}

https://api.capgo.app/organization/members/

从组织中删除成员。立即撤销他们的访问权限。

interface MemberDelete {
orgId: string
email: string
}
终端窗口
curl -X DELETE \
-H "authorization: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"orgId": "org_123",
"email": "user@example.com"
}' \
https://api.capgo.app/organization/members/
{
"status": "OK"
}

常见错误场景及其响应:

// Member not found
{
"error": "Member not found",
"status": "KO"
}
// Invalid role
{
"error": "Invalid role specified",
"status": "KO"
}
// Permission denied
{
"error": "Insufficient permissions to manage members",
"status": "KO"
}
// Cannot remove last admin
{
"error": "Cannot remove the last admin from the organization",
"status": "KO"
}
// Invalid email
{
"error": "Invalid email format",
"status": "KO"
}
// Member already exists
{
"error": "Member already exists in organization",
"status": "KO"
}

常见用例

常见用例
  1. 团队扩张: 为团队成员添加适当角色
  2. 访问控制: 根据责任变化管理成员权限
  3. 安全审计: 定期审查成员列表和角色
  4. 团队重构: 在组织变化时更新角色

如果您正在使用 成员 来规划安全性和合规性, 加密 加密 安全扫描器 安全扫描器 Capgo Security Scanner for the product workflow in Capgo Security Scanner, Capgo Capgo Capgo 信任中心 Capgo 产品工作流程在信任中心。