.. AUTO-GENERATED FILE. DO NOT EDIT.

one-users-patch-one
===================

Source
------

- Repository: ``jef-systems/jef-one-backend``
- Source Run ID: ``25256541517``
- Source SHA: ``944e655286e0c87c6e611453ffc46df43159a83d``
- Module: ``one``
- Documentation Scope: ``async``
- Lambda: ``jef-one-patch-26``

Endpoint
--------

- API Name: ``jef-one``
- Action Name: ``patch``
- Method: ``PATCH``
- Scope Label: ``Async``
- Resource Path: ``/one-users-patch-one``
- Complete Endpoint: ``https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-users-patch-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-one-patch-26``
- curl payload mode: ``json_body``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-one-patch-26
   Module: jef-one
   Action: patch
   Method: PATCH
   Invocation Mode: ASYNC
   Resource Path: /one-users-patch-one
   
   API Gateway Response:
   - status_code: 202
   - message: Request accepted for asynchronous processing.
   
   Table:
   - table: jef-one-users
   
   Payload Example:
   - pk: EMP0001
   - entity_number: 1001
   - employee_number: EMP0001
   - display_name: Admin User
   - password_hash: sample-password-hash-admin
   - is_active: True
   - roles: [{"module_number":"01","role_name":"admin"},{"module_number":"02","role_name":"manager"}]
   - created_at: 2026-04-29T00:00:00Z
   - updated_at: 2026-04-29T00:00:00Z
   - password_updated_at: 2026-04-29T00:00:00Z
   
   Payload Schema:
   - pk: string-{employee_number}
   - entity_number: string
   - employee_number: string
   - display_name: string
   - password_hash: string
   - is_active: boolean
   - roles: string
   - created_at: string
   - updated_at: string
   - password_updated_at: string
   
   Response Schema:
   - is_accepted: boolean
   - message: string

Request Payload
---------------

.. code-block:: json

   {
     "pk": "EMP0001",
     "entity_number": "1001",
     "employee_number": "EMP0001",
     "display_name": "Admin User",
     "password_hash": "sample-password-hash-admin",
     "is_active": "True",
     "roles": "[{\"module_number\":\"01\",\"role_name\":\"admin\"},{\"module_number\":\"02\",\"role_name\":\"manager\"}]",
     "created_at": "2026-04-29T00:00:00Z",
     "updated_at": "2026-04-29T00:00:00Z",
     "password_updated_at": "2026-04-29T00:00:00Z"
   }

Response
--------

.. code-block:: json

   {
     "is_accepted": "boolean",
     "message": "string"
   }

CMD curl
--------

.. code-block:: text

   curl -X PATCH "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-users-patch-one" -H "Content-Type: application/json" --data-raw "{\"pk\": \"EMP0001\", \"entity_number\": \"1001\", \"employee_number\": \"EMP0001\", \"display_name\": \"Admin User\", \"password_hash\": \"sample-password-hash-admin\", \"is_active\": true, \"roles\": \"[{\\\"module_number\\\":\\\"01\\\",\\\"role_name\\\":\\\"admin\\\"},{\\\"module_number\\\":\\\"02\\\",\\\"role_name\\\":\\\"manager\\\"}]\", \"created_at\": \"2026-04-29T00:00:00Z\", \"updated_at\": \"2026-04-29T00:00:00Z\", \"password_updated_at\": \"2026-04-29T00:00:00Z\"}"

PowerShell curl
---------------

.. code-block:: text

   curl.exe -X PATCH "https://mfr670zvsh.execute-api.ap-southeast-1.amazonaws.com/prod/one-users-patch-one" -H "Content-Type: application/json" --data-raw '{"pk": "EMP0001", "entity_number": "1001", "employee_number": "EMP0001", "display_name": "Admin User", "password_hash": "sample-password-hash-admin", "is_active": true, "roles": "[{\"module_number\":\"01\",\"role_name\":\"admin\"},{\"module_number\":\"02\",\"role_name\":\"manager\"}]", "created_at": "2026-04-29T00:00:00Z", "updated_at": "2026-04-29T00:00:00Z", "password_updated_at": "2026-04-29T00:00:00Z"}'