コンテンツにスキップ

プロジェクトのユーザー一覧

メソッド

REST メソッドを採用しています。

HTTP メソッド

GET: プロジェクトに割り当てられた有効なユーザーの一覧取得

命名規則

URI パラメータには snake_case、JSON レスポンスフィールドには camelCase を使用します。

リクエストとレスポンス

ヘッダー

リクエストヘッダー

  • Authorization: Bearer <access_token>
  • Content-Type: application/json

URI

/api/v1/projects/{project_id}/users
名前 型 必須 説明
project_id integer 必須 プロジェクト ID

レスポンス(200 OK)

{
  "list": [
    {
      "id": 12,
      "userId": 4,
      "projectId": 3,
      "projectAccess": "2",
      "createdAt": 1788422400000,
      "updatedAt": 1788422400000,
      "createdBy": "admin-cognito-sub",
      "updatedBy": "admin-cognito-sub",
      "deletedAt": null,
      "deletedBy": null
    }
  ]
}

projectAccess は "1" が読み取り、"2" が読み取り・書き込みです。

認証要件

ユーザーとプロジェクトの読み取り権限を持つ管理者 Cognito Bearer トークンが必要です。

例外処理

説明 ステータスコード ステータス名
トークンが欠落または無効 401 Unauthorized
ユーザーまたはプロジェクトの権限不足 403 Forbidden
プロジェクトが見つからない 404 Not Found

処理フロー

  1. 管理者セッションと読み取り権限を検証します。
  2. project_id から有効なプロジェクトを取得します。
  3. プロジェクトの有効なユーザー割り当てを返します。

ソース: apps/admin/src/routes/v1/user-project.ts