chore: update signin to sign-in and add additional references

jjarvisp · jjarvisp · commit c61ad3e8f89e · 2024-10-30T17:29:12.000-07:00
diff --git a/src/pages/[platform]/build-a-backend/auth/connect-your-frontend/multi-step-sign-in/index.mdx b/src/pages/[platform]/build-a-backend/auth/connect-your-frontend/multi-step-sign-in/index.mdx
@@ -116,7 +116,7 @@ if (nextStep.signInStep === 'DONE') {
 }
 ```
 
-## Confirm signin with SMS MFA
+## Confirm sign-in with SMS MFA
 
 If the next step is `CONFIRM_SIGN_IN_WITH_SMS_CODE`, Amplify Auth has sent the user a random code over SMS and is waiting for the user to verify that code. To handle this step, your app's UI must prompt the user to enter the code. After the user enters the code, pass the value to the `confirmSignIn` API.
 
@@ -154,7 +154,7 @@ async function confirmMfaCode(mfaCode: string) {
 
 ```
 
-## Confirm signin with TOTP MFA
+## Confirm sign-in with TOTP MFA
 
 If the next step is `CONFIRM_SIGN_IN_WITH_TOTP_CODE`, you should prompt the user to enter the TOTP code from their associated authenticator app during set up. The code is a six-digit number that changes every 30 seconds. The user must enter the code before the 30-second window expires.
 
@@ -184,7 +184,7 @@ async function confirmTotpCode(totpCode: string) {
 
 ```
 
-## Confirm signin with Email MFA
+## Confirm sign-in with Email MFA
 
 If the next step is `CONFIRM_SIGN_IN_WITH_EMAIL_CODE`, Amplify Auth has sent the user a random code to their email address and is waiting for the user to verify that code. To handle this step, your app's UI must prompt the user to enter the code. After the user enters the code, pass the value to the `confirmSignIn` API.
 
@@ -223,7 +223,7 @@ async function confirmMfaCode(mfaCode: string) {
 ```
 
 
-## Continue signin with MFA Selection
+## Continue sign-in with MFA Selection
 
 If the next step is `CONTINUE_SIGN_IN_WITH_MFA_SELECTION`, the user must select the MFA method to use. Amplify Auth currently supports SMS, TOTP, and EMAIL as MFA methods. After the user selects an MFA method, your implementation must pass the selected MFA method to Amplify Auth using `confirmSignIn` API.
 
@@ -265,7 +265,7 @@ async function handleMfaSelection(mfaType: MfaType) {
 
 ```
 
-## Continue signin with Email Setup
+## Continue sign-in with Email Setup
 
 If the next step is `CONTINUE_SIGN_IN_WITH_EMAIL_SETUP`, then the user must provide an email address to complete the sign in process. Once this value has been collected from the user, call the `confirmSignIn` API to continue.
 
@@ -290,7 +290,7 @@ async function confirmEmail(email: string) {
 
 ```
 
-## Continue signin with TOTP Setup
+## Continue sign-in with TOTP Setup
 
 The `CONTINUE_SIGN_IN_WITH_TOTP_SETUP` step signifies that the user must set up TOTP before they can sign in. The step returns an associated value of type TOTPSetupDetails which must be used to configure an authenticator app like Microsoft Authenticator or Google Authenticator. TOTPSetupDetails provides a helper method called getSetupURI which generates a URI that can be used, for example, in a button to open the user's installed authenticator app. For more advanced use cases, TOTPSetupDetails also contains a sharedSecret which can be used to either generate a QR code or be manually entered into an authenticator app.
 
@@ -322,7 +322,7 @@ async function confirmTotpCode(totpCode: string) {
 
 ```
 
-## Continue signin with MFA Setup Selection
+## Continue sign-in with MFA Setup Selection
 
 If the next step is `CONTINUE_SIGN_IN_WITH_MFA_SETUP_SELECTION`, then the user must indicate which of the available MFA methods they would like to setup. After the user selects an MFA method to setup, your implementation must pass the selected MFA method to the `confirmSignIn` API.
 
@@ -361,7 +361,7 @@ async function handleMfaSelection(mfaType: MfaType) {
 
 ```
 
-## Confirm signin with custom challenge
+## Confirm sign-in with custom challenge
 
 If the next step is `CONFIRM_SIGN_IN_WITH_CUSTOM_CHALLENGE`, Amplify Auth is awaiting completion of a custom authentication challenge. The challenge is based on the AWS Lambda trigger you configured as part of a custom sign in flow.
 
@@ -402,12 +402,14 @@ If `failAuthentication=true` is returned by the Lambda, Cognito will invalidate
 
 </Callout>
 
-## Confirm signin with new password
+## Confirm sign-in with new password
 
 If the next step is `CONFIRM_SIGN_IN_WITH_NEW_PASSWORD_REQUIRED`, Amplify Auth requires the user choose a new password they proceeding with the sign in. 
 
 Prompt the user for a new password and pass it to the `confirmSignIn` API.
 
+See the [sign-in](/[platform]/build-a-backend/auth/connect-your-frontend/sign-in/) and [manage-password](/[platform]/build-a-backend/auth/manage-users/manage-passwords/) docs for more information.
+
 ```ts
 import { type SignInOutput, confirmSignIn } from '@aws-amplify/auth';
 
@@ -482,7 +484,7 @@ async function handleResetPasswordResult(
 If the next step is `CONFIRM_SIGN_UP`, Amplify Auth requires that the user confirm their email or phone number before proceeding.
 Use the `resendSignUpCode` API to send a new sign up code to the registered email or phone number, followed by `confirmSignUp` to complete the sign up.
 
-See the [confirm sign up](/[platform]/build-a-backend/auth/connect-your-frontend/sign-up/#confirm-sign-up) docs for more information.
+See the [sign up](/[platform]/build-a-backend/auth/connect-your-frontend/sign-up/) docs for more information.
 
 <Callout>
 
@@ -612,7 +614,7 @@ Future<void> _handleSignInResult(SignInResult result) async {
   }
 }
 ```
-## Confirm signin with SMS MFA
+## Confirm sign-in with SMS MFA
 
 If the next step is `confirmSignInWithSmsMfaCode`, Amplify Auth has sent the user a random code over SMS and is waiting for the user to verify that code. To handle this step, your app's UI must prompt the user to enter the code. After the user enters the code, pass the value to the `confirmSignIn` API.
 
@@ -654,7 +656,7 @@ Future<void> confirmMfaUser(String mfaCode) async {
 }
 ```
 
-## Confirm signin with TOTP MFA
+## Confirm sign-in with TOTP MFA
 
 If the next step is `confirmSignInWithTOTPCode`, you should prompt the user to enter the TOTP code from their associated authenticator app during set up. The code is a six-digit number that changes every 30 seconds. The user must enter the code before the 30-second window expires.
 
@@ -685,7 +687,7 @@ Future<void> confirmTotpUser(String totpCode) async {
 }
 ```
 
-## Confirm signin with Email MFA
+## Confirm sign-in with Email MFA
 
 If the next step is `confirmSignInWithOtpCode`, Amplify Auth has sent the user a random code to their email address and is waiting for the user to verify that code. To handle this step, your app's UI must prompt the user to enter the code. After the user enters the code, pass the value to the `confirmSignIn` API.
 
@@ -728,7 +730,7 @@ Future<void> confirmMfaUser(String mfaCode) async {
 ```
 
 
-## Continue signin with MFA Selection
+## Continue sign-in with MFA Selection
 
 If the next step is `continueSignInWithMFASelection`, the user must select the MFA method to use. Amplify Auth currently supports SMS, TOTP, and email as MFA methods. After the user selects an MFA method, your implementation must pass the selected MFA method to Amplify Auth using `confirmSignIn` API.
 
@@ -766,7 +768,7 @@ Future<void> _handleMfaSelection(MfaType selection) async {
 }
 ```
 
-## Continue signin with Email Setup
+## Continue sign-in with Email Setup
 
 If the next step is `continueSignInWithEmailMfaSetup`, then the user must provide an email address to complete the sign in process. Once this value has been collected from the user, call the `confirmSignIn` API to continue.
 
@@ -794,7 +796,7 @@ Future<void> confirmEmailUser(String emailAddress) async {
 }
 ```
 
-## Continue signin with TOTP Setup
+## Continue sign-in with TOTP Setup
 
 If the next step is `continueSignInWithTOTPSetup`, then the user must provide a TOTP code to complete the sign in process. The step returns an associated value of type `TOTPSetupDetails` which would be used for generating TOTP. `TOTPSetupDetails` provides a helper method called `getSetupURI` that can be used to generate a URI, which can be used by native password managers for TOTP association. For example. if the URI is used on Apple platforms, it will trigger the platform's native password manager to associate TOTP with the account. For more advanced use cases, `TOTPSetupDetails` also contains the `sharedSecret` that will be used to either generate a QR code or can be manually entered into an authenticator app.
 
@@ -827,7 +829,7 @@ Future<void> confirmTotpUser(String totpCode) async {
 }
 ```
 
-## Continue signin with MFA Setup Selection
+## Continue sign-in with MFA Setup Selection
 If the next step is `continueSignInWithMfaSetupSelection`, then the user must indicate which of the available MFA methods they would like to setup. After the user selects an MFA method to setup, your implementation must pass the selected MFA method to the `confirmSignIn` API.
 
 The MFA types which are currently supported by Amplify Auth are:
@@ -864,7 +866,7 @@ Future<void> _handleMfaSelection(MfaType selection) async {
 }
 ```
 
-## Confirm signin with custom challenge
+## Confirm sign-in with custom challenge
 
 If the next step is `confirmSignInWithCustomChallenge`, Amplify Auth is awaiting completion of a custom authentication challenge. The challenge is based on the AWS Lambda trigger you configured as part of a [custom sign in flow](/[platform]/build-a-backend/auth/customize-auth-lifecycle/custom-auth-flows/#sign-in-a-user).
 
@@ -906,7 +908,7 @@ If `failAuthentication=true` is returned by the Lambda, Cognito will invalidate
 
 </Callout>
 
-## Confirm signin with new password
+## Confirm sign-in with new password
 If the next step is `confirmSignInWithNewPassword`, Amplify Auth requires the user choose a new password they proceeding with the sign in. 
 
 Prompt the user for a new password and pass it to the `confirmSignIn` API.
@@ -1459,7 +1461,7 @@ RxAmplify.Auth.signIn("username", "password", options).subscribe(
 
 </BlockSwitcher>
 
-## Confirm signin with SMS MFA
+## Confirm sign-in with SMS MFA
 
 If the next step is `CONFIRM_SIGN_IN_WITH_SMS_MFA_CODE`, Amplify Auth has sent the user a random code over SMS, and is waiting to find out if the user successfully received it. To handle this step, your app's UI must prompt the user to enter the code. After the user enters the code, your implementation must pass the value to Amplify Auth `confirmSignIn` API.
 
@@ -1559,38 +1561,38 @@ RxAmplify.Auth.confirmSignIn(
 
 </BlockSwitcher>
 
-## Confirm signin with TOTP MFA
+## Confirm sign-in with TOTP MFA
 
 If the next step is `CONFIRM_SIGN_IN_WITH_TOTP_CODE`, you should prompt the user to enter the TOTP code from their associated authenticator app during set up. The code is a six-digit number that changes every 30 seconds. The user must enter the code before the 30-second window expires.
 
 After the user enters the code, your implementation must pass the value to Amplify Auth `confirmSignIn` API.
 
 
-## Confirm signin with Email MFA
+## Confirm sign-in with Email MFA
 
 If the next step is `CONFIRM_SIGN_IN_WITH_EMAIL_MFA_CODE`, Amplify Auth has sent the user a random code to their email address and is waiting to find out if the user successfully received it. To handle this step, your app's UI must prompt the user to enter the code. After the user enters the code, your implementation must pass the value to Amplify Auth `confirmSignIn` API.
 
 Note: the signIn result also includes an `AuthCodeDeliveryDetails` member. It includes additional information about the code delivery such as the partial email address of the recipient.
 
-## Continue signin with MFA Selection
+## Continue sign-in with MFA Selection
 
 If the next step is `CONTINUE_SIGN_IN_WITH_MFA_SELECTION`, the user must select the MFA method to use. Amplify Auth currently supports SMS, TOTP, and email as MFA methods. After the user selects an MFA method, your implementation must pass the selected MFA method to Amplify Auth using `confirmSignIn` API.
 
-## Continue signin with Email Setup
+## Continue sign-in with Email Setup
 
 If the next step is `CONTINUE_SIGN_IN_WITH_EMAIL_MFA_SETUP`, then the user must provide an email address to complete the sign in process. Once this value has been collected from the user, call the `confirmSignIn` API to continue.
 
-## Continue signin with TOTP Setup
+## Continue sign-in with TOTP Setup
 
 If the next step is `CONTINUE_SIGN_IN_WITH_TOTP_SETUP`, then the user must provide a TOTP code to complete the sign in process. The step returns an associated value of type `TOTPSetupDetails` which would be used for generating TOTP. `TOTPSetupDetails` provides a helper method called `getSetupURI` that can be used to generate a URI, which can be used by native password managers for TOTP association. For example. if the URI is used on Apple platforms, it will trigger the platform's native password manager to associate TOTP with the account. For more advanced use cases, `TOTPSetupDetails` also contains the `sharedSecret` that will be used to either generate a QR code or can be manually entered into an authenticator app.
 
 Once the authenticator app is set up, the user can generate a TOTP code and provide it to the library to complete the sign in process.
 
-## Continue signin with MFA Setup Selection
+## Continue sign-in with MFA Setup Selection
 
 If the next step is `CONTINUE_SIGN_IN_WITH_MFA_SETUP_SELECTION`, the user must select the MFA method to setup. Amplify Auth currently supports SMS, TOTP, and email as MFA methods. After the user selects an MFA method, your implementation must pass the selected MFA method to Amplify Auth using `confirmSignIn` API.
 
-## Confirm signin with custom challenge
+## Confirm sign-in with custom challenge
 
 If the next step is `CONFIRM_SIGN_IN_WITH_CUSTOM_CHALLENGE`, Amplify Auth is awaiting completion of a custom authentication challenge. The challenge is based on the Lambda trigger you setup when you configured a [custom sign in flow](/[platform]/build-a-backend/auth/customize-auth-lifecycle/custom-auth-flows/#sign-in-a-user). To complete this step, you should prompt the user for the custom challenge answer, and pass the answer to the `confirmSignIn` API.
 
@@ -1704,7 +1706,7 @@ NotAuthorizedException{message=Failed since user is not authorized., cause=NotAu
 
 </Callout>
 
-## Confirm signin with new password
+## Confirm sign-in with new password
 If you receive a `UserNotConfirmedException` while signing in, Amplify Auth requires a new password for the user before they can proceed. Prompt the user for a new password and pass it to the `confirmSignIn` API.
 
 <BlockSwitcher>
@@ -2100,7 +2102,7 @@ func signIn(username: String, password: String) async {
 
 The `nextStep` property is of enum type `AuthSignInStep`. Depending on its value, your code should take one of the following actions:
 
-## Confirm signin with SMS MFA
+## Confirm sign-in with SMS MFA
 If the next step is `confirmSignInWithSMSMFACode`, Amplify Auth has sent the user a random code over SMS, and is waiting to find out if the user successfully received it. To handle this step, your app's UI must prompt the user to enter the code. After the user enters the code, your implementation must pass the value to Amplify Auth `confirmSignIn` API.
 
 Note: the signin result also includes an `AuthCodeDeliveryDetails` member. It includes additional information about the code delivery such as the partial phone number of the SMS recipient.
@@ -2161,7 +2163,7 @@ func confirmSignIn(confirmationCodeFromUser: String) -> AnyCancellable {
 
 </BlockSwitcher>
 
-## Confirm signin with TOTP MFA
+## Confirm sign-in with TOTP MFA
 
 If the next step is `confirmSignInWithTOTPCode`, you should prompt the user to enter the TOTP code from their associated authenticator app during set up. The code is a six-digit number that changes every 30 seconds. The user must enter the code before the 30-second window expires.
 
@@ -2222,7 +2224,7 @@ func confirmSignIn(totpCode: String) -> AnyCancellable {
 </BlockSwitcher>
 
 
-## Confirm signin with Email MFA
+## Confirm sign-in with Email MFA
 If the next step is `confirmSignInWithOTP`, Amplify Auth has sent a random code to the user's email address, and is waiting to find out if the user successfully received it. To handle this step, your app's UI must prompt the user to enter the code. After the user enters the code, your implementation must pass the value to Amplify Auth `confirmSignIn` API.
 
 <Callout info>
@@ -2288,7 +2290,7 @@ func confirmSignIn(confirmationCodeFromUser: String) -> AnyCancellable {
 </BlockSwitcher>
 
 
-## Continue signin with MFA Selection
+## Continue sign-in with MFA Selection
 
 If the next step is `continueSignInWithMFASelection`, the user must select the MFA method to use. Amplify Auth currently supports SMS, TOTP, and email as MFA methods. After the user selects an MFA method, your implementation must pass the selected MFA method to Amplify Auth using `confirmSignIn` API.
 
@@ -2338,7 +2340,7 @@ func confirmSignInWithTOTPAsMFASelection() -> AnyCancellable {
 
 </BlockSwitcher>
 
-## Continue signin with Email Setup
+## Continue sign-in with Email Setup
 If the next step is `continueSignInWithEmailMFASetup`, then the user must provide an email address to complete the sign in process. Once this value has been collected from the user, call the `confirmSignIn` API to continue.
 
 ```swift 
@@ -2350,7 +2352,7 @@ case .continueSignInWithEmailMFASetup:
     // Then invoke `confirmSignIn` api with the email address
 ```
 
-## Continue signin with TOTP Setup
+## Continue sign-in with TOTP Setup
 
 If the next step is `continueSignInWithTOTPSetup`, then the user must provide a TOTP code to complete the sign in process. The step returns an associated value of type `TOTPSetupDetails` which would be used for generating TOTP. `TOTPSetupDetails` provides a helper method called `getSetupURI` that can be used to generate a URI, which can be used by native password managers for TOTP association. For example. if the URI is used on Apple platforms, it will trigger the platform's native password manager to associate TOTP with the account. For more advanced use cases, `TOTPSetupDetails` also contains the `sharedSecret` that will be used to either generate a QR code or can be manually entered into an authenticator app.
 
@@ -2423,7 +2425,7 @@ func confirmSignInWithTOTPSetup(totpCodeFromAuthenticatorApp: String) -> AnyCanc
 
 </BlockSwitcher>
 
-## Continue signin with MFA Setup Selection
+## Continue sign-in with MFA Setup Selection
 
 If the next step is `continueSignInWithMFASetupSelection`, the user must indicate which of the available MFA methods they would like to setup. After the user selects an MFA method to setup, your implementation must pass the selected MFA method to the `confirmSignIn` API.
 
@@ -2473,7 +2475,7 @@ func continueSignInWithEmailMFASetupSelection() -> AnyCancellable {
 
 </BlockSwitcher>
 
-## Confirm signin with custom challenge
+## Confirm sign-in with custom challenge
 
 If the next step is `confirmSignInWithCustomChallenge`, Amplify Auth is awaiting completion of a custom authentication challenge. The challenge is based on the Lambda trigger you setup when you configured a [custom sign in flow](/[platform]/build-a-backend/auth/customize-auth-lifecycle/custom-auth-flows/#sign-in-a-user). To complete this step, you should prompt the user for the custom challenge answer, and pass the answer to the `confirmSignIn` API.
 
@@ -2544,7 +2546,7 @@ Exception:  notAuthorized{message=Failed since user is not authorized., cause=No
 
 </Callout>
 
-## Confirm signin with new password
+## Confirm sign-in with new password
 
 If the next step is `confirmSignInWithNewPassword`, Amplify Auth requires a new password for the user before they can proceed. Prompt the user for a new password and pass it to the `confirmSignIn` API.
 
