.. AUTO-GENERATED FILE. DO NOT EDIT.

auth-login-verify
=================

Source
------

- Repository: ``jef-systems/jef-login-backend``
- Source Run ID: ``24472624921``
- Source SHA: ``84f6c59edbf284569e9889897763e643855aa510``
- Module: ``login``
- Documentation Scope: ``get``
- Lambda: ``jef-login-get-login-verify``

Endpoint
--------

- API Name: ``jef-login``
- Action Name: ``get``
- Method: ``GET``
- Scope Label: ``GET``
- Resource Path: ``/auth-login-verify``
- Complete Endpoint: ``https://mzx26r2ye4.execute-api.ap-southeast-1.amazonaws.com/prod/auth-login-verify``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-login-get-login-verify``
- curl payload mode: ``query_string``

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

.. code-block:: text

   Function: jef-login-get-login-verify
   API Name: jef-login
   Action: get
   Method: GET
   Resource Path: /auth-login-verify
   
   Payload:
   - entity_number: string-4-digits-nonzerostart
   - employee_number: string-5-digits
   - password: string
   
   Response:
   - exists: boolean
   - message: string
   - item: {"pk":"string","gsi_1_pk":"string","gsi_1_sk":"string","gsi_2_pk":"string","gsi_2_sk":"string","session_id":"string","session_number":"string","entity_number":"string","employee_number":"string","employee_name":"string","role":"string","device_id":"string","platform":"string","ip":"string-optional","user_agent":"string-optional","date":"string-YYYY-MM-DD","date_name":"string-Month, Day, Year, Weekday","created":"string-iso8601","created_name":"string-Month, Day, Year, Weekday, Hour:Minute AM/PM","last_seen":"string-iso8601","last_seen_name":"string-Month, Day, Year, Weekday, Hour:Minute AM/PM","expires_at":"string-iso8601","expires_at_name":"string-Month, Day, Year, Weekday, Hour:Minute AM/PM","revoked_at":"string-optional","revoked_at_name":"string-optional","message":"string","is_valid":"boolean","token":"string","login_type":"string"}

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

.. code-block:: json

   {
     "entity_number": "string-4-digits-nonzerostart",
     "employee_number": "string-5-digits",
     "password": "string"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "item": "{\"pk\":\"string\",\"gsi_1_pk\":\"string\",\"gsi_1_sk\":\"string\",\"gsi_2_pk\":\"string\",\"gsi_2_sk\":\"string\",\"session_id\":\"string\",\"session_number\":\"string\",\"entity_number\":\"string\",\"employee_number\":\"string\",\"employee_name\":\"string\",\"role\":\"string\",\"device_id\":\"string\",\"platform\":\"string\",\"ip\":\"string-optional\",\"user_agent\":\"string-optional\",\"date\":\"string-YYYY-MM-DD\",\"date_name\":\"string-Month, Day, Year, Weekday\",\"created\":\"string-iso8601\",\"created_name\":\"string-Month, Day, Year, Weekday, Hour:Minute AM/PM\",\"last_seen\":\"string-iso8601\",\"last_seen_name\":\"string-Month, Day, Year, Weekday, Hour:Minute AM/PM\",\"expires_at\":\"string-iso8601\",\"expires_at_name\":\"string-Month, Day, Year, Weekday, Hour:Minute AM/PM\",\"revoked_at\":\"string-optional\",\"revoked_at_name\":\"string-optional\",\"message\":\"string\",\"is_valid\":\"boolean\",\"token\":\"string\",\"login_type\":\"string\"}"
   }

CMD curl
--------

.. code-block:: text

   curl "https://mzx26r2ye4.execute-api.ap-southeast-1.amazonaws.com/prod/auth-login-verify?entity_number=string-4-digits-nonzerostart&employee_number=string-5-digits&password=string"

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

.. code-block:: text

   curl.exe "https://mzx26r2ye4.execute-api.ap-southeast-1.amazonaws.com/prod/auth-login-verify?entity_number=string-4-digits-nonzerostart&employee_number=string-5-digits&password=string"