When successful, the message ought to say something like, "An email has been sent with a temporary password."
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Begin Setup for App MFA
Returns secret code to enter into the MFA App.
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Conclude a password reset by supplying the code from the email along with a new password.
Ought to tell them they can now log in with their new password.
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Confirm Setup for App MFA
When successful, the message ought to say something like, "Your MFA app has been successfully configured."
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Main login call which either produces a user object and credentials, or returns a challenge.
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Corresponds to the challenge a user with MFA enabled gets to verify their MFA code.
Note that the session here would be from a previous ChallengeResponse. This is not the Authorization token, these values are passed back and forth in each step of a Challenge Response interaction.
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Corresponds to the initial challenge a user receives after making their account so they can create a new one.
Note that the session here would be from a previous ChallengeResponse. This is not the Authorization token, these values are passed back and forth in each step of a Challenge Response interaction.
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Refresh login call which only requires a token and ought to produce fresh credentials, unless it has been more than a month.
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Corresponds to the challenge a user with MFA enabled gets to verify their MFA code.
Note that the session here would be from a previous ChallengeResponse. This is not the Authorization token, these values are passed back and forth in each step of a Challenge Response interaction.
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Sets user MFA preferences
Returns which MFA method (if any) is enabled
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Setup Phone Number for SMS MFA
Phone numbers must follow these formatting rules: A phone number must start with a plus (+) sign, followed immediately by the country code. A phone number can only contain the + sign and digits. You must remove any other characters from a phone number, such as parentheses, spaces, or dashes (-) before submitting the value to the service. For example, a United States-based phone number must follow this format: +14325551212. (Sourced from: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html)
When successful, the message ought to say something like, "Your phone number has been registered for SMS MFA."
Type guard; only returns true for valid Args objects.
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.
Subpaths available on the auth endpoint. Built into an enum for easy change later on.
Decoded API response from a call to our login endpoint. It either contains successful authentication ora challenge for the user to respond to.
Response from a call to our login endpoint. It either contains successful authentication or a challenge for the user to respond to.
Baseline path from which more specific auth paths are built on top of.
Generated using TypeDoc
Initiate a password reset. This call will trigger an email containing the passwordResetCode which must be provided to confirm the reset.