회원

Capgo의 구성원은 Capgo에 대한 접근 권한이 있는 사용자입니다. 각 구성원은 특정 역할을 가지고 있으며, 그 역할에 따라 Capgo 내에서의 권한이 결정됩니다. 구성원 관리는 팀 내의 보안과 협업을 유지하기 위해 중요합니다.

역할

일반 역할

• 읽기: 리소스를 볼 수 있지만 변경할 수 없습니다
• 업로드: 새로운 패키지를 업로드하고 리소스를 볼 수 있습니다
• 수정: 리소스를 수정하고 패키지를 업로드할 수 있습니다
• 관리자__: Can manage organization settings and members__
• __:super_admin____: Has full control over the organization__

__: Invite Roles__

• __: invite_read__: Pending invitation for read access____: invite_upload__: Pending invitation for upload access__
• __: invite_write__: Pending invitation for write access____: invite_admin__: Pending invitation for admin access__
• __: Invite Roles____Invite Roles__
• __Invite Roles____CAPGO_KEEP_0__
• 관리자 접근 권한 초대 중__CAPGO_KEEP_1__

최선의 실천 방법

1. 역할 할당역할 할당 시 최소 권한 원칙을 따르세요
2. 정기적인 감사회원 접근 권한을 정기적으로 검토하고 사용하지 않는 계정을 삭제하세요
3. 회원 가입새로운 회원을 추가하고 역할을 할당하는 명확한 프로세스를 갖추세요
4. 퇴사: 조직에서 탈퇴한 멤버의 접근 권한을 즉시 제거합니다.

Endpoints

POST

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

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

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 계정을 이미 가지고 있어야 초대 받을 수 있습니다. 계정이 없다면 Capgo 콘솔에서 계정을 먼저 생성해야 합니다. https://console.capgo.app/register/

GET

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

쿼리 매개변수

GET

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

DELETE

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

회원 제거

Request Body

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. : 권한 관리 및 역할 변경에 따라: __CAPGO_KEEP_0__ 목록과 역할을 정기적으로 검토합니다.
4. 팀 구조 개선: 조직적 변화 시 역할을 업데이트 합니다.

멤버 목록에서 계속

__CAPGO_KEEP_1__을 사용하는 경우 멤버 __CAPGO_KEEP_2__과 __CAPGO_KEEP_2__을 연결하여 보안 및 규정 준수 계획을 만듭니다. 암호화 __CAPGO_KEEP_3__의 구현 세부 사항 규정 준수 __CAPGO_KEEP_3__의 구현 세부 사항 Capgo 보안 스캐너 Capgo 보안 스캐너의 제품 워크플로우에 대해 Capgo 보안 Capgo 보안의 제품 워크플로우에 대해, 그리고 Capgo 신뢰 센터 Capgo 신뢰 센터의 제품 워크플로우에 대해.