メンバー

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

メンバーの役割

通常の役割

• 読み取り: リソースを表示できますが、変更はできません
• アップロード: バンドルのアップロードとリソースの表示が可能です
• write: リソースの編集とバンドルのアップロードが可能です
• admin: 組織の設定とメンバーの管理が可能です
• 管理者: 組織の全ての制御が可能です

役割招待

• 招待を読む: 読み取り権の招待中です
• アップロード招待: 上传アクセスへの招待待ち
• 招待書作成: 書き込みアクセスへの招待待ち
• 管理者招待: 管理者アクセスへの招待待ち
• 管理者招待: スーパーマネージャー アクセスへの招待待ち

ベストプラクティス

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

Endpoints

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. セキュリティーアウディット: メンバーのリストと役割を定期的に確認する
4. チーム再構築: 組織の変更に伴う役割の更新

メンバーから続けて

あなたが Members をセキュリティとコンプライアンスの計画に使用している場合、 暗号化 暗号化の実装詳細のために 法的適合性 暗号化の実装詳細のために Capgo セキュリティ スキャナー Capgo セキュリティ スキャナーの製品ワークフローのために Capgo セキュリティ Capgo セキュリティの製品ワークフローのために、 Capgo トラスト センター Capgo トラスト センターの製品ワークフローのために