멤버

조직 멤버는 Capgo 조직에 접근할 수 있는 사용자입니다. 각 멤버는 조직 내에서 권한을 결정하는 특정 역할을 가지고 있습니다. 조직 관리는 보안 및 팀 협력을 유지하기 위해 중요합니다.

멤버 역할

정규 역할

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

초대 역할

• invite_read: 읽기 권한 초대待
• invite_upload: 업로드 권한 초대待
• invite_write: 쓰기 권한 초대待
• invite_admin: 관리자 권한 초대待
• invite_super_admin: 슈퍼 관리자 권한 초대待

최선의 방법

1. 역할 assignments: 최소 권한 원칙을 따르면 역할 assignments
2. 정기적인 Audits: 사용하지 않는 계정의 member access를 정기적으로 검토하고 제거
3. Onboarding: 새로운 member를 추가하는 clear한 process를 가집니다
4. Offboarding: organization에서 떠나는 member의 access를 신속하게 제거

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/

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

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

삭제

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 Security for the product workflow in Capgo Security, and Capgo 신뢰 센터 Capgo 신뢰 센터의 제품 워크플로에 대해.