メンバー

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

メンバーのロール

通常のロール

• 読み取り: リソースを表示できますが、変更はできません
• アップロード: 新しいバンドルをアップロードし、リソースを表示できます
• 書き込み: リソースを変更し、バンドルをアップロードできます
• 管理者: 組織の設定とメンバーを管理できます
• 超管理者: 組織に対して完全な制御権を持っています

招待ロール

• invite_read: 読み取り権限の招待中
• invite_upload: アップロード権限の招待中
• invite_write: 書き込み権限の招待中
• invite_admin: 管理者権限の招待中
• invite_super_admin: スーパーアドミン権限の招待中

ベストプラクティス

1. 役割の割り当て: 最小限の特権原則に従って役割を割り当てます
2. 定期的な検査: メンバーのアクセスを定期的に確認し、使用されていないアカウントを削除します
3. 加入: 新しいメンバーを追加するための明確なプロセスを持ち、役割を割り当てます
4. 退会: 組織を離れたメンバーのアクセスを即座に削除します

セクションのタイトル “エンドポイント”

Section titled “Endpoints”

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

組織または既存のメンバーの役割を更新するために、新しいメンバーを追加します。ただし、既存のCapgoアカウントを持つユーザーを招待することができ、メールアドレスは既存のCapgoユーザーに一致する必要があります。

Request Body

interface MemberCreate {
  orgId: string
  email: string
  role: "read" | "upload" | "write" | "admin" | "super_admin"
}

Example Request

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/

Success Response

{
  "status": "OK",
  "data": {
    "uid": "user_789",
    "email": "newmember@example.com",
    "role": "invite_write",
    "image_url": null
  }
}

Notes:

• 新メンバーを追加する場合、招待メールを受け取ることになります。招待を受け入れるまで、役割は「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. セキュリティアウディット:メンバーのリストと役割を定期的に確認
4. チームの再構築:組織の変更に伴う役割の更新

Membersから続きます

あなたが「 メンバー」を使用している場合 セキュリティとコンプライアンスの計画に使用している場合 Encryption Encryption __CAPGO_KEEP_0__ セキュリティ スキャナー __CAPGO_KEEP_0__ セキュリティ スキャナー Capgo セキュリティ Capgo セキュリティ Capgo Security for the product workflow in Capgo Security, and Capgo の信頼センター Capgo の製品ワークフローについての信頼センター