.. AUTO-GENERATED FILE. DO NOT EDIT.

DELETE /one-delete-session-job
==============================

Summary
-------

- **Source repository:** ``jef-systems/jef-one-backend``
- **Source SHA:** ``e96c5a3e498688e508b48a6c244ebbcb28dec45f``
- **Source run id:** ``25680569267``
- **Module:** ``One``
- **Lambda function:** ``jef-one-delete-session-job``
- **HTTP method:** ``DELETE``
- **Invocation mode:** ``async``
- **Package mode:** ``with-packages``
- **API category:** ``One Complex With Package Async DELETE APIs``
- **API path:** ``/one-delete-session-job``
- **Endpoint URL:** ``https://1agiiayfri.execute-api.ap-southeast-1.amazonaws.com/prod/one-delete-session-job``
- **Documentation scope:** ``lambda-complex-with-packages``

Async Confirmation Rule
-----------------------

This write API is documented as an async accepted request, not final write success.
Use the corresponding GET API to confirm the final state.

Description
-----------

Accepts an asynchronous job to delete a jef-one session. Use GET to confirm final state.

Payload Example
---------------

.. code-block:: json

   {
     "session_id": "session-00001",
     "reason": "logout"
   }

Payload Schema
--------------

.. code-block:: json

   {
     "session_id": "string",
     "reason": "string"
   }

Response Schema
---------------

.. code-block:: json

   {
     "is_accepted": "boolean",
     "message": "string",
     "operation": "string",
     "job_id": "string",
     "job_status": "string",
     "target_table": "string",
     "target_pk": "string",
     "confirmation": "string",
     "allowed_method": "string",
     "error_type": "string",
     "error_code": "string",
     "errors": "array",
     "error": "string"
   }

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

.. code-block:: json

   {
     "session_id": "session-00001",
     "reason": "logout"
   }

CMD curl
--------

.. code-block:: bat

   curl -X DELETE "https://1agiiayfri.execute-api.ap-southeast-1.amazonaws.com/prod/one-delete-session-job" -H "Content-Type: application/json" -d '{"session_id": "session-00001", "reason": "logout"}'

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

.. code-block:: powershell

   curl.exe -X DELETE "https://1agiiayfri.execute-api.ap-southeast-1.amazonaws.com/prod/one-delete-session-job" -H "Content-Type: application/json" -d "{\"session_id\": \"session-00001\", \"reason\": \"logout\"}"