メンバー

組織メンバーは、Capgo組織にアクセスできるユーザーです。各メンバーには、組織内での権限を決定する特定のロールが割り当てられます。メンバーを効果的に管理することは、チーム内のセキュリティとコラボレーションの維持に不可欠です。

メンバーの役割

通常のロール

• : リソースを表示できますが、変更はできません。: 新しいバンドルをアップロードし、リソースを表示できます。
• : リソースを変更し、バンドルをアップロードできます。: リソースを変更し、バンドルをアップロードできます。
• admin: リソースを変更し、バンドルをアップロードできます。
• : リソースを変更し、バンドルをアップロードできます。: 組織の設定とメンバーを管理できます
• __CAPGO_KEEP_0__: 組織の全ての制御権限を持っています

ロールを招待

• : 読み取り権限の招待待ち: アップロード権限の招待待ち
• : 書き込み権限の招待待ち: 管理権限の招待待ち
• __CAPGO_KEEP_0____CAPGO_KEEP_0__
• __CAPGO_KEEP_0__管理者アクセスの招待待ち
• invite_super_adminスーパーアドミンアクセスの招待待ち

ベストプラクティス

1. ロール割り当てロール割り当ての原則
2. 定期的なアクセスレビュー新規メンバーのオンボーディング
3. メンバーのオフボーディング新規メンバーの追加とロール割り当てのプロセス
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アカウントを持っている必要があります。 アカウントがなければ、まず 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"
    }
  ]
}

削除

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. セキュリティの検査: __CAPGO_KEEP_0__リストの確認と役割の定期的な確認
4. チームの再構成: 組織の変更に伴う役割の更新