メンバー

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

メンバーの役割

通常の役割

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

ロール招待

• 招待読み取り: 招待中（読み取り権限)
• invite_upload: 招待中（アップロード権限)
• invite_write: 招待中（書き込み権限)
• invite_admin: 招待中（管理者権限)
• invite_super_admin: 招待中（最高管理者権限)

Best Practices

1. Role Assignment: 最小特権原則に従ってロールを割り当ててください。
2. 通常の監査: メンバーのアクセスを定期的に確認し、使用されていないアカウントを削除してください。
3. 加入: 新しいメンバーを追加し、ロールを割り当てる明確なプロセスを用意してください。
4. 退職: 組織から離れたメンバーのアクセスをすぐに削除してください。

エンドポイント

POST

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

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

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_3__

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/

__CAPGO_KEEP_7__

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

__CAPGO_KEEP_10__

• When adding a new member, they will receive an invitation email. Their role will be prefixed with “__CAPGO_KEEP_11__” until they accept the invitation.
• The user must already have a Capgo account before they can be invited. If they don’t have an account, they should first create one at 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"

Example Response

{
  "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/

メンバーを削除する。すぐにアクセスを取り消します。

Request Body

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. 「メンバーから続ける」セクション: 「メンバー」機能を使用している場合

__CAPGO_KEEP_0__

__CAPGO_KEEP_2__ メンバー をセキュリティとコンプライアンスの計画に接続する 暗号化 暗号化の実装詳細について コンプライアンス コンプライアンスの実装詳細について Capgo セキュリティ スキャナー Capgo セキュリティ スキャナーの製品ワークフローについて Capgo セキュリティ Capgo セキュリティの製品ワークフローについて Capgo トラスト センター Capgo トラスト センターの製品ワークフローについて