メンバー

Organization membersは、Capgo組織へのアクセス権を持つユーザーです。各メンバーには特定のロールが割り当てられ、組織内での権限が決定されます。セキュリティの維持とチーム内の円滑なコラボレーションには、メンバーの適切な管理が不可欠です。

メンバーのロール

標準ロール

• 読み取り：リソースの閲覧は可能ですが、変更はできません
• upload：新しいbundleのuploadおよびリソースの閲覧が可能です
• write: リソースの変更およびbundleのuploadが可能
• admin: 組織設定およびメンバーの管理が可能
• super_admin: 組織の全権限を保持

招待ロール

• 招待の読み取り: 読み取り権限の招待待ち
• アップロードの招待: upload権限の招待待ち
• 招待の書き込み権限: 書き込み権限の招待が保留中です
• 管理者として招待: 管理者権限の招待が保留中です
• スーパー管理者として招待: スーパー管理者権限の招待が保留中です

ベストプラクティス

1. ロールの割り当て: ロールを割り当てる際は最小権限の原則に従ってください
2. 定期的な監査: 定期的にメンバーのアクセス権を確認し、不要なアカウントを削除してください
3. Onboarding: 新規メンバーの追加とロール割り当てのプロセスを明確にする
4. Offboarding: 退職したメンバーのアクセス権を速やかに削除する

エンドポイント

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 アカウントを持っている必要があります。アカウントをお持ちでない場合は、まずこちらから作成してください： 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"
    }
  ]
}

DELETE

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

エラーハンドリング

すべてのエラーは、次で説明されている標準エラー形式を使用します： API の概要.

よくあるエラーシナリオとそのレスポンス：

// The API key has no access to the organization
{
  "error": "cannot_access_organization",
  "message": "You can't access this organization",
  "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }
}

// Unknown role on update
{
  "error": "invalid_role",
  "message": "Invalid role",
  "moreInfo": { "role": "owner" }
}

// Changing the role of the user who owns the API key
{
  "error": "cannot_change_own_role",
  "message": "You cannot change your own role",
  "moreInfo": {}
}

// Removing a user who is not a member (HTTP 404)
{
  "error": "organization_member_not_found",
  "message": "User is not a member of this organization",
  "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8", "email": "user@example.com" }
}

// Removing the last super admin
{
  "error": "CANNOT_REMOVE_LAST_SUPER_ADMIN",
  "message": "Cannot remove the last super admin from the organization",
  "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }
}

よくあるユースケース

1. チーム拡大: 適切なロールを持つ新しいチームメンバーの追加
2. アクセス制御: 役割の変化に応じたメンバー権限の管理
3. セキュリティ監査: メンバーリストとロールの定期的な確認
4. チームの再編成: 組織変更に伴うロールの更新

Members から続ける

以下を使用している場合： メンバー セキュリティとコンプライアンスの計画に使う場合は、以下と連携してください： 暗号化 実装の詳細は「暗号化」を参照： コンプライアンス 実装の詳細は「コンプライアンス」を参照： Capgo セキュリティスキャナー Capgo セキュリティスキャナーの製品ワークフローについては： Capgo セキュリティ Capgo Security でのプロダクトワークフロー向け、および Capgo トラストセンター Capgo Trust Center でのプロダクトワークフロー向け。