ClaytonWWilson/Listify
1
0
Fork 0
mirror of https://github.com/ClaytonWWilson/Listify.git synced 2025-12-16 18:48:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
a57e4888ce
Listify/Lambdas/Lists/User
History
Nathan Merz 337372f5f3
Merge pull request #164 from ClaytonWWilson/readmes 
Readmes
2020-12-03 22:03:39 -05:00
..
resources Delete Lambda prototype 2020-10-05 12:29:28 -04:00
src Fix null id on user retrieval 2020-12-03 17:49:32 -05:00
test Update lambda tests 2020-11-01 12:46:03 -05:00
README.md Create User module readme 2020-12-03 22:03:04 -05:00

README.md

User Module

Wraps certain Cognito functionality to provide greater ease of use for the developer than always calling Cognitor directly and using service hooks.

UserGET

Retrieves information on a user's cognitoID or email. This Lambda exists for ease of use in retrieving/converting between returns.

Potential Inputs (choose 1)

  • (query paramter) id: A user email or a Cognito id. Note: relies on the assumption that Cognito ids do not have "@" and emails do
  • (body element) emailToCheck: A user email
  • No input (or null/empty string inputs)

Returns:

  • A User object (if asking for an email, the Cognito id may be incorrect)
    • No input results in only the Cognito id being populated with the requestor's id.
    • Should something about the contract be broken, or the user not exist, a null, or null-populated, value will be returned

UserDELETE

Deletes a user and their data. This Lambda exists to ease database cleanup and sending a farewell email.

Inputs:

None, this only uses the Congito id collected by AWS Gateway

Returns:

null