멤버

조직 멤버는 Capgo 조직에 대한 접근 권한이 있는 사용자입니다. 각 멤버는 조직 내에서 권한을 결정하는 특정 역할을 가지고 있습니다. 조직 관리를 효과적으로 관리하는 것은 팀 내에서 보안 및 협력을 유지하는 데 중요합니다.

멤버 역할

정규 역할

• 읽기: 리소스를 볼 수 있지만 변경을 할 수 없습니다
• 업로드: 새로운 패키지 업로드 및 리소스 보기
• 수정: 리소스 수정 및 패키지 업로드
• 관리자: 조직 설정 및 멤버 관리
• 슈퍼 관리자: 조직에 대한 전체 제어

초대 역할

• 읽기 초대: 읽기 접근 권한으로의 초대 중
• 업로드 접근 초대: 업로드 접근 초대 중입니다.
• 쓰기 접근 초대: 쓰기 접근 초대 중입니다.
• 관리자 접근 초대: 관리자 접근 초대 중입니다.
• 관리자 권한 부여: 최소 권한 원칙에 따라 관리자 권한을 부여하세요.

최고관리자 접근 초대

1. 최선의 관행최선의 관행 섹션입니다. (Best Practices Section titled “Best Practices”.)
2. 정규 감사: 사용자 접근 권한을 정기적으로 검토하고 사용하지 않는 계정을 제거합니다
3. 온보딩: 새로운 멤버를 추가하고 역할을 assign하는 명확한 프로세스를 가집니다
4. 오프보딩: 조직을 떠나는 멤버의 접근 권한을 즉시 제거합니다

엔드포인트

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

참고:

• 새 멤버를 추가할 때, 그들은 초대 이메일을 받게 됩니다. 그들의 역할은 초대 받은 후에 "invite_"로 시작하게 됩니다.
• 사용자는 Capgo 계정을 이미 가지고 있어야 초대 받을 수 있습니다. 계정이 없다면 Capgo 계정을 생성해야 합니다. https://console.capgo.app/register/

GET

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

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

Query Parameters

interface MemberQuery {
  orgId: string
}

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

DELETE

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

요청 본문

요청 본문 섹션

interface MemberDelete {
  orgId: string
  email: string
}

targetLanguage

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_KEEP_0__

: __CAPGO_KEEP_1__ 만약 __CAPGO_KEEP_2__ 사용 중이라면 보안 및 규정 준수 계획을 수립하기 위해 연결하세요. 암호화 __CAPGO_KEEP_0__ 암호화 구현 세부 정보에 대해 규정 준수 __CAPGO_KEEP_0__ 규정 준수 구현 세부 정보에 대해 Capgo 보안 스캐너 Capgo 보안 스캐너의 제품 워크플로에 대해 Capgo 보안 Capgo 보안의 제품 워크플로에 대해 Capgo 신뢰 센터 Capgo 신뢰 센터의 제품 워크플로에 대해