APIリファレンス

ユーザー

プロジェクトのユーザーを管理します。すべてのエンドポイントはシークレットキーが必要でサーバーサイド専用です。

サーバーサイド専用

すべてのユーザー管理エンドポイントには sk_live_ シークレットキーが必要です。クライアントサイドのコードには絶対に公開しないでください。

GET/v1/dashboard/users

ユーザー一覧

現在のプロジェクトのすべてのユーザーを一覧表示します。シークレットキーが必要です。

クエリパラメータ

text

?limit=20&offset=0&search=john&projectId=proj_abc123

レスポンス

json

{
  "users": [
    {
      "id": "usr_abc123",
      "email": "user@example.com",
      "displayName": "John Doe",
      "avatarUrl": null,
      "isBanned": false,
      "signInCount": 5,
      "lastSignInAt": "2026-01-15T10:30:00Z",
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ],
  "total": 42
}

GET/v1/dashboard/users/:userId

ユーザー取得

IDでユーザーと連携プロバイダー、アクティブセッションを取得します。

レスポンス

json

{
  "id": "usr_abc123",
  "email": "user@example.com",
  "displayName": "John Doe",
  "providers": ["google", "github"],
  "sessions": [...],
  "publicMetadata": {}
}

PATCH/v1/dashboard/users/:userId/ban

ユーザーBAN

ユーザーをBANします。すべてのアクティブセッションを失効させ、今後のサインインを防ぎます。

レスポンス

json

{ "success": true }

PATCH/v1/dashboard/users/:userId/unban

ユーザーBAN解除

ユーザーのBANを解除し、再びサインインできるようにします。

レスポンス

json

{ "success": true }

DELETE/v1/dashboard/users/:userId

ユーザー削除

ユーザーとすべてのデータを完全に削除します。この操作は元に戻せません。

レスポンス

json

{ "success": true }