멤버

Capgo 조직의 사용자입니다. 각 멤버는 조직 내 권한을 결정하는 특정 역할을 가지고 있습니다. 조직의 보안 및 협업을 유지하기 위해 멤버를 효과적으로 관리하는 것은 중요합니다.

멤버 역할

정규 역할

• 읽기: 리소스를 볼 수 있지만 변경할 수 없습니다
• 업로드: 새로운 번들을 업로드하고 리소스를 볼 수 있습니다
• 수정: 리소스를 수정하고 번들을 업로드할 수 있습니다
• 관리자: 조직 설정과 멤버를 관리할 수 있습니다
• 슈퍼 관리자: 조직에 대한 전체 제어권을 가지고 있습니다

초대 역할

• 초대 읽기: 읽기 접근 허용을 위한 초대
• 초대 업로드: 업로드 접근 허용을 위한 초대
• 초대 쓰기: 쓰기 접근 허용을 위한 초대
• 초대 관리자: 관리자 접근 허용을 위한 초대
• 초대 슈퍼 관리자: 슈퍼 관리자 접근 허용을 위한 초대

최선의 방법

1. 역할 assign: 최소 권한 원칙에 따라 역할 assign
2. 정기적인 검토: 사용하지 않는 계정 제거
3. 온보딩: 새로운 멤버 추가 및 역할 assign
4. 오프보딩: 조직을 떠난 멤버에 대한 접근 제거

Endpoints

POST

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

새로운 멤버를 조직에 추가하거나 기존 멤버의 역할을 업데이트합니다. 참고로, 이미 Capgo 계정이 있는 사용자만 초대할 수 있습니다 - 이메일은 이미 Capgo 사용자와 일치해야 합니다.

요청 본문

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
  }
}

주의:

• 새 멤버를 추가할 때, 그들은 초대 이메일을 받게 됩니다. 그들의 역할은 초대 받을 때까지 “초대_”로 시작됩니다.
• 사용자는 초대 받기 전에 이미 Capgo 계정을 가지고 있어야 합니다. 계정이 없다면, 먼저 https://console.capgo.app/register/

GET

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

조직의 모든 멤버를 가져옵니다.

쿼리 매개변수

interface MemberQuery {
  orgId: string
}

응답 형식

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 보안 스캐너 Capgo 보안 스캐너의 제품 워크플로우를 위해 Capgo 보안 Capgo 보안의 제품 워크플로우를 위해 Capgo 신뢰 센터 Capgo 제품 워크플로우에 대한 신뢰 센터.