Skip to content

List Project Users

Method

REST method is adopted.

HTTP Method

GET: List active user assignments for a project

Naming Convention

snake_case is used for URI parameters. JSON response fields use camelCase.

Request and Response

Headers

Request Headers

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

URI

/api/v1/projects/{project_id}/users
Name Type Required Description
project_id integer Required Project ID

Response (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 is "1" for read access and "2" for read/write access.

Authentication

A valid admin Cognito Bearer token with read access to users and projects is required.

Exception Handling

Description Status Code Status Name
Missing or invalid token 401 Unauthorized
Insufficient user or project permission 403 Forbidden
Project not found 404 Not Found

Process Flow

  1. Validate the admin session and read permissions.
  2. Resolve the active project by project_id.
  3. Return its active user assignments.

Source: apps/admin/src/routes/v1/user-project.ts