Every app needs authentication and authorization. Logto is an Auth0 alternative designed for modern apps and SaaS products.
In this article, we will go through the steps to quickly build the AWS SES sign-in experience (user authentication) with React and Logto.
Prerequisites
- A running Logto instance. Check out the get started page if you don't have one.
- Basic knowledge of React.
- A usable AWS SES account.
Create an application in Logto
In you browser, open a new tab and enter the link of Logto Admin Console.
Once the page is loaded, in the "Get Started" section click the View all
link to open the application framework list page.
Choose your application type
In the opening modal, scroll to the "Single page app" section or filter all the available " Single page app" frameworks using the quick filter checkboxes on the left.
Click the "React" framework card to start creating your application.
Enter application name
Enter the application name, e.g., "Bookstore," and click "Create Application."
🎉 Ta-da! You just created your first application in Logto. You'll see a congrats page which includes a detailed integration guide. Follow the guide to see what the experience will be in your application.
Integrate Logto SDK
- The sample project is available on our SDK repository.
- The tutorial video is available on our YouTube channel.
Installation
- npm
- Yarn
- pnpm
npm i @logto/react
yarn add @logto/react
pnpm add @logto/react
Init LogtoClient
In the following code snippets, we assume your app is running on http://localhost:3000
.
Import and use LogtoProvider
to provide a Logto context:
import { LogtoProvider, LogtoConfig } from '@logto/react';
const config: LogtoConfig = {
endpoint: '<your-logto-endpoint>', // E.g. http://localhost:3001
appId: '<your-application-id>',
};
const App = () => (
<LogtoProvider config={config}>
<YourAppContent />
</LogtoProvider>
);
Implement sign-in
The sign-in flow can be simplified as:
Configure sign-in redirect URI
Let's switch to the Application details page of Logto Console. Add a Redirect URI
http://localhost:3000/callback
and click "Save Changes".
Redirect URI is an OAuth 2.0 concept which implies the location should redirect after authentication.
Implement a sign-in button
We provide two hooks useHandleSignInCallback()
and useLogto()
which can help you easily manage the authentication flow.
Before calling .signIn()
, make sure you have correctly configured Redirect URI
in Admin Console.
Go back to your IDE/editor, use the following code to implement the sign-in button:
import { useLogto } from '@logto/react';
const SignIn = () => {
const { signIn, isAuthenticated } = useLogto();
if (isAuthenticated) {
return <div>Signed in</div>;
}
return <button onClick={() => signIn('http://localhost:3000/callback')}>Sign In</button>;
};
Handle redirect
We're almost there! In the last step, we use http://localhost:3000/callback
as the Redirect URI, and now we need to handle it properly.
First let's create a callback component:
import { useHandleSignInCallback } from '@logto/react';
const Callback = () => {
const { isLoading } = useHandleSignInCallback(() => {
// Navigate to root path when finished
});
// When it's working in progress
if (isLoading) {
return <div>Redirecting...</div>;
}
return null;
};
Finally insert the code below to create a /callback
route which does NOT require authentication:
// Assuming react-router
<Route path="/callback" element={<Callback />} />
Implement sign-out
Calling .signOut()
will clear all the Logto data in memory and localStorage if they exist.
After signing out, it'll be great to redirect your user back to your website. Let's add http://localhost:3000
as one of the Post Sign-out URIs in Admin Console (shows under Redirect URIs), and use the URL as the parameter when calling .signOut()
.
Implement a sign-out button
const SignOut = () => {
const { signOut } = useLogto();
return <button onClick={() => signOut('http://localhost:3000')}>Sign out</button>;
};
Handle authentication status
In Logto SDK, generally we can use logtoClient.isAuthenticated
to check the authentication status, if the user is signed in, the value will be true
, otherwise, the value will be false
.
In Logto React SDK, the isAuthenticated
status can be checked by using the useLogto
hook. In the example code below, we can use it to programmatically show and hide the sign-in and sign-out buttons. And also use getIdTokenClaims
to get the id of the currently logged-in user.
const Home = () => {
const { isAuthenticated, getIdTokenClaims, signIn, signOut } = useLogto();
const [userId, setUserId] = useState('');
useEffect(() => {
(async () => {
if (isAuthenticated) {
const claims = await getIdTokenClaims();
setUserId(claims.sub);
}
})();
}, [isAuthenticated]);
return (
<div>
{userId && <p>Logged in as {userId}</p>}
{isAuthenticated ? (
<button onClick={signOut}>Sign Out</button>
) : (
<button onClick={() => signIn('http://localhost:3000/callback')}>Sign In</button>
)}
</div>
);
};
Open your React app to test if the integration works. When you click the "Sign In" button, the page should be redirected to a Logto sign-in page, and you should be able to create a new account by entering username and password and complete the sign-in process.
Add AWS SES connector
To add or change Email connector, go to the "Connector" tab in the Admin Console, then click on "Email and SMS connectors". From there, click "Set up" or go to detail page and click "Change Email connector".
In the openning modal, select "AWS SES" and click "Next".
On the next page, you will see a two-column layout with the README content on the left and configuration on the right.
Feel free to follow the README file in place or read the following section to complete the configuration process. If you follow the in-place guide, you can skip the next section.
Set up AWS SES email connector
Configure a mail service in the AWS service console
Amazon SES is a cloud email service provider that can integrate into any application for bulk email sending.
Logto core calls the Amazon Simple Email Service APIs via this connector, with the help of which Logto end-users can register and sign in to their Logto account via email verification code.
💡 Tip
You can skip some sections if you have already finished.
Register AWS account
Go to AWS and register an account.
Create a identity
- Go to
Amazon Simple Email Service
Console - Create an identity, choose one of the following options
- Create a domain
- Create an email address
Configuration of the connector
- Click your username in the upper right corner of the Amazon console to enter
Security Credentials
. If you don't have one, create anAccessKey
and save it carefully. - Complete the settings of the
Amazon Simple Email Service
connector:- Use the
AccessKey ID
andAccessKey Secret
obtained in step 1 to fill inaccessKeyId
andaccessKeySecret
respectively. region
: Fill in theregion
field with the region of the identity you use to send mail.emailAddress
: The email address you use to send mail, in the format ofLogto<[email protected]>
or<[email protected]>
- Use the
the following parameters are optional; parameters description can be found in the AWS SES API documentation.
feedbackForwardingEmailAddress
feedbackForwardingEmailAddressIdentityArn
configurationSetName
Test the Amazon SES connector
You can type in an email address and click on "Send" to see whether the settings work before "Save and Done".
That's it. Don't forget to enable connector in sign-in experience.
Configure types
Name | Type |
---|---|
accessKeyId | string |
accessKeySecret | string |
region | string |
emailAddress | string (OPTIONAL) |
emailAddressIdentityArn | string (OPTIONAL) |
feedbackForwardingEmailAddress | string (OPTIONAL) |
feedbackForwardingEmailAddressIdentityArn | string (OPTIONAL) |
configurationSetName | string (OPTIONAL) |
templates | Template[] |
Template Properties | Type | Enum values |
---|---|---|
subject | string | N/A |
content | string | N/A |
usageType | enum string | 'Register' | 'SignIn' | 'ForgotPassword' | 'Generic' |
Save your configuration
Double check you have filled out necessary values in the Logto connector configuration area. Click "Save and Done" (or "Save Changes") and the AWS SES connector should be available now.
Enable AWS SES connector in Sign-in Experience
Switch to the "Sign-in Experience" tab, then click the "Sign-up and Sign-in" tab.
If it's the first time you enter the tab, you will see a quick introduction about Sign-in Experience and its basic configuration.
Select "Email address" or "Email address or phone number" for the "Sign-up identifier" to provide sign-up for Email passwordless sign-in, which may increase your conversion rate.
Finally, click "Save Changes" on the bottom right corner.
Testing and Validation
Return to your React app. You should now be able to sign in with AWS SES. Enjoy!
Further readings
⚔️ Protect your API For native and single page apps, you'll need to call one or more API endpoints to retrieve and update data.
Learn more about identifying who's who and keeping your API secure.
🧑🚀 Manage users We know you care about user management and activities, as we also do.
Learn more about how to know your users and see the figures like DAU and MAU graphically.
🌐 Localization From one regional business to a global corporate, the willingness to offer the best user experience won't change.
You can change current language phrases or add a new language without friction.
🧑🎓 Customer IAM series Our serial blog posts about Customer (or Consumer) Identity and Access Management, from 101 to advanced topics and beyond.