Create User

Method

REST method is adopted.

HTTP Method

POST: Create a new app user

Naming Convention

To unify naming of query parameters and nodes and improve readability, snake_case is used for URIs and nodes in JSON during requests.

Request and Response

Headers

Meta information is set in HTTP headers rather than in the response body.

Request Headers

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

Response Headers

• Content-Type: application/json

Create User

URI

/api/v1/users

Request Body

Request body is JSON.

{
  "email": "user@example.com",
  "temporaryPassword": "TempPass123",
  "name": "John Doe",
  "organizationId": 1
}

Validation Rules

Field	Rule
email	Required. Must be a valid email format.
temporaryPassword	Required. Minimum 8 characters. Cognito will force a password change on first login.
name	Required. 1-255 characters.
organizationId	Required. Must be a positive integer referencing an existing organization.

Response (201 Created)

Response is JSON.

{
  "id": 1,
  "cognitoSub": "1111-aaaa-2222-bbbb",
  "organizationId": 1,
  "name": "John Doe",
  "createdAt": 1640995200000,
  "updatedAt": 1640995200000,
  "createdBy": "1111-aaaa-2222-bbbb",
  "updatedBy": "1111-aaaa-2222-bbbb",
  "deletedAt": null,
  "deletedBy": null
}

Authentication

Authentication is performed using JSON Web Tokens (JWT) issued by Amazon Cognito. A valid Bearer token is required in the Authorization header.

Exception Handling

Exception handling status codes are as follows.

Description	Status Code	Status Name
Missing or invalid token	401	Unauthorized
Organization not found	404	Not Found
Duplicate user or Cognito conflict	409	Conflict
Internal server error	500	Internal Server Error

Process Flow

Sequence Diagram

sequenceDiagram
    participant Client
    participant Middleware as Protected Route Middleware
    participant API as Hono Router
    participant Service as User Service
    participant Cognito as App Cognito Pool
    participant DB as PostgreSQL Database

    Client->>Middleware: POST /api/v1/users
    Middleware->>Middleware: Verify JWT & session

    alt Token Valid
        Middleware-->>API: Auth info (sub)
        API->>Service: create({ email, tempPassword, name, orgId, actorSub })
        Service->>DB: Find organization by ID

        alt Organization Found
            Service->>Cognito: adminCreateUserWithTempPassword
            Cognito-->>Service: User created
            Service->>Cognito: getCognitoSubByEmail
            Cognito-->>Service: cognitoSub

            alt DB Insert Success
                Service->>DB: Create user record
                DB-->>Service: User record
                Service-->>API: User with relations
                API-->>Client: 201 Created
            else DB Insert Failed
                Service->>Cognito: adminDeleteUser (rollback)
                Service-->>API: throw Error
                API-->>Client: 500 Internal Server Error
            end
        else Organization Not Found
            DB-->>Service: null
            Service-->>API: throw NotFoundError
            API-->>Client: 404 Not Found
        end
    else Token Invalid
        Middleware-->>Client: 401 Unauthorized
    end

Routes Layer

API routing is performed here. The protectedRoute middleware validates the JWT token. The handler validates the request body via Zod schema, extracts the actor's Cognito sub, and delegates to the user service.

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

Services Layer

This section describes business logic. It validates the organization exists, creates the user in the app Cognito pool with a temporary password, resolves the Cognito sub, and creates the database record. If the DB insert fails, it rolls back by deleting the Cognito user.

Source: apps/admin/src/services/user.ts

Repositories Layer

This section describes access to databases and external services. It handles organization lookup, Cognito user creation/sub-resolution/deletion, and user record creation.

Source: apps/admin/src/repositories/user.ts / apps/admin/src/repositories/cognito-pool.ts

Security

• Token validated by protectedRoute middleware before handler execution
• Cognito rollback on DB failure prevents orphaned Cognito users
• Temporary password forces user to change password on first login