メンバー

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

メンバーの役割

通常の役割

• read: リソースを表示できますが、変更はできません
• アップロード: 新しいバンドルをアップロードし、リソースを表示できます
• 書き込み: リソースを編集し、バンドルをアップロードできます
• 管理者: 組織の設定とメンバーを管理できます
• スーパーアドミン: 組織全体の制御権を持っています

招待ロール

• 招待読み取り: 読み取り権の招待待ち
• 招待アップロード: アップロードアクセスの招待待ち
• 招待書き込み: 書き込みアクセスの招待待ち
• 招待管理者: 管理者アクセスの招待待ち
• 招待最高管理者: 最高管理者アクセスの招待待ち

ベスト プラクティス

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

DELETE

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

リクエストボディ

「リクエストボディ」のセクション

interface MemberDelete {
  orgId: string
  email: string
}

Example Response

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_0__ メンバーを使用している場合 セキュリティとコンプライアンスの計画に役立つように接続してください。 暗号化 __CAPGO_KEEP_0__ セキュリティ スキャナーの実装詳細 コンプライアンス __CAPGO_KEEP_0__ セキュリティ スキャナーの製品ワークフロー Capgo セキュリティ Capgo セキュリティ スキャナーの製品ワークフロー Capgo トラスト センター Capgo セキュリティの製品ワークフロー Capgo トラスト センターの製品ワークフロー for the product workflow in Capgo Trust Center.