내용으로 건너뛰기

멤버

Capgo 팀의 보안 및 협업을 유지하기 위해 회원 관리를 효과적으로하는 것은 중요합니다. 팀의 모든 구성원이 Capgo 팀에 접근할 수 있는 사용자입니다. 각 회원은 팀 내에서 권한을 결정하는 특정 역할을 가지고 있습니다.

정규 역할

정규 역할
  • 읽기: 자원 보기만 가능
  • 업로드: 새로운 번들 업로드 및 자원 보기
  • 수정: 자원 수정 및 번들 업로드
  • 관리자: 조직 설정 및 멤버 관리
  • 슈퍼 관리자: 조직 전체 제어
  • invite_read: 읽기 권한 초대待
  • invite_upload: 업로드 권한 초대待
  • invite_write: 쓰기 권한 초대待
  • invite_admin: 관리자 권한 초대待
  • invite_super_admin: 슈퍼 관리자 권한 초대待
  1. 역할 할당: 최소 권한 원칙을 따르면 역할을 할당할 때
  2. 정기적인 감사: 회원 접근을 정기적으로 검토하고 사용하지 않는 계정을 삭제하십시오
  3. 온보딩: 새로운 회원을 추가하고 역할을 할당하는 명확한 프로세스를 갖도록 하십시오
  4. 오프보딩: 조직을 떠나는 회원의 접근 권한을 즉시 삭제하십시오

POST

POST

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

Add a new member to an organization or update an existing member’s role. Note that you can only invite users who already have a Capgo account - the email must correspond to an existing Capgo user.

요청 본문

요청 본문
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
}
}

Notes:

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

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

Query Parameters

Query Parameters 섹션

복사
interface MemberQuery {
orgId: string
}

Response Type 섹션

Copy to clipboard
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 신뢰 센터의 제품 워크플로에 대해.