Skip to main content
For our new friends:

Logto is an Auth0 alternative designed for modern apps and SaaS products. It offers both Cloud and Open-source services to help you quickly launch your identity and management (IAM) system. Enjoy authentication, authorization, and multi-tenant management all in one.

We recommend starting with a free development tenant on Logto Cloud. This allows you to explore all the features easily.

In this article, we will go through the steps to quickly build the Tencent sign-in experience (user authentication) with Next.js (App Router) and Logto.

Prerequisites

Create an application in Logto​

Logto is based on OpenID Connect (OIDC) authentication and OAuth 2.0 authorization. It supports federated identity management across multiple applications, commonly called Single Sign-On (SSO).

To create your Traditional web application, simply follow these steps:

  1. Open the Logto Console. In the "Get started" section, click the "View all" link to open the application frameworks list. Alternatively, you can navigate to Logto Console > Applications, and click the "Create application" button. Get started
  2. In the opening modal, click the "Traditional web" section or filter all the available "Traditional web" frameworks using the quick filter checkboxes on the left. Click the "Next.js (App Router)" framework card to start creating your application. Frameworks
  3. 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 Next.js (App Router) with Logto​

tip:

Installation​

Install Logto SDK via your favorite package manager:

npm i @logto/next

Prepare configs​

Prepare configuration for the Logto client:

app/logto.ts
import { LogtoNextConfig } from '@logto/next';

export const logtoConfig: LogtoNextConfig = {
  appId: '<your-application-id>',
  appSecret: '<your-app-secret-copied-from-console>',
  endpoint: '<your-logto-endpoint>', // E.g. http://localhost:3001
  baseUrl: '<your-nextjs-app-base-url>', // E.g. http://localhost:3000
  cookieSecret: 'complex_password_at_least_32_characters_long',
  cookieSecure: process.env.NODE_ENV === 'production',
};

Configure redirect URIs​

Before we dive into the details, here's a quick overview of the end-user experience. The sign-in process can be simplified as follows:

  1. Your app invokes the sign-in method.
  2. The user is redirected to the Logto sign-in page. For native apps, the system browser is opened.
  3. The user signs in and is redirected back to your app (configured as the redirect URI).

Regarding redirect-based sign-in​

  1. This authentication process follows the OpenID Connect (OIDC) protocol, and Logto enforces strict security measures to protect user sign-in.
  2. If you have multiple apps, you can use the same identity provider (Logto). Once the user signs in to one app, Logto will automatically complete the sign-in process when the user accesses another app.

To learn more about the rationale and benefits of redirect-based sign-in, see Logto sign-in experience explained.

note:

In the following code snippets, we assume your app is running on http://localhost:3000/.

Configure redirect URIs​

Switch to the application details page of Logto Console. Add a redirect URI http://localhost:3000/callback.

Redirect URI in Logto Console

Just like signing in, users should be redirected to Logto for signing out of the shared session. Once finished, it would be great to redirect the user back to your website. For example, add http://localhost:3000/ as the post sign-out redirect URI section.

Then click "Save" to save the changes.

Handle callback​

After the user signs in, Logto will redirect the user back to the redirect URI configured above. However, there are still things to do to make your application work properly.

We provide a helper function handleSignIn to handle the sign-in callback:

app/callback/route.ts
import { handleSignIn } from '@logto/next/server-actions';
import { redirect } from 'next/navigation';
import { NextRequest } from 'next/server';
import { logtoConfig } from '../logto';

export async function GET(request: NextRequest) {
  const searchParams = request.nextUrl.searchParams;
  await handleSignIn(logtoConfig, searchParams);

  redirect('/');
}

Implement sign-in and sign-out​

Implement sign-in and sign-out button​

In Next.js App Router, events are handled in client components, so we need to create two components first: SignIn and SignOut.

app/sign-in.tsx
'use client';

type Props = {
  onSignIn: () => Promise<void>;
};

const SignIn = ({ onSignIn }: Props) => {
  return (
    <button
      onClick={() => {
        onSignIn();
      }}
    >
      Sign In
    </button>
  );
};

export default SignIn;
app/sign-out.tsx
'use client';

type Props = {
  onSignOut: () => Promise<void>;
};

const SignOut = ({ onSignOut }: Props) => {
  return (
    <button
      onClick={() => {
        onSignOut();
      }}
    >
      Sign Out
    </button>
  );
};

export default SignOut;

Remember to add 'use client' to the top of the file to indicate that these components are client components.

Add buttons to home page​

note:

It is not allowed to define inline "use server" annotated Server Actions in Client Components. We have to pass it down through props from a Server Component.

Now let's add the sign-in and sign-out buttons in your home page. We need to call the server actions in SDK when needed. To help with this, use getLogtoContext to fetch authentication status.

app/page.tsx
import { getLogtoContext, signIn, signOut } from '@logto/next/server-actions';
import SignIn from './sign-in';
import SignOut from './sign-out';
import { logtoConfig } from './logto';

const Home = () => {
  const { isAuthenticated, claims } = await getLogtoContext(logtoConfig);

  return (
    <nav>
      {isAuthenticated ? (
        <p>
          Hello, {claims?.sub},
          <SignOut
            onSignOut={async () => {
              'use server';

              await signOut(logtoConfig);
            }}
          />
        </p>
      ) : (
        <p>
          <SignIn
            onSignIn={async () => {
              'use server';

              await signIn(logtoConfig);
            }}
          />
        </p>
      )}
    </nav>
  );
};

export default Home;

Checkpoint: Test your application​

Now, you can test your application:

  1. Run your application, you will see the sign-in button.
  2. Click the sign-in button, the SDK will init the sign-in process and redirect you to the Logto sign-in page.
  3. After you signed in, you will be redirected back to your application and see the sign-out button.
  4. Click the sign-out button to clear token storage and sign out.

Add Tencent connector​

SMS connector is a method used to send one-time passwords (OTPs) for authentication. It enables Phone number verification to support passwordless authentication, including SMS-based registration, sign-in, two-factor authentication (2FA), and account recovery. You can easily connect Tencent as your SMS provider. With the Logto SMS connector, you can set this up in just a few minutes.

To add a SMS connector, simply follow these steps:

  1. Navigate to Console > Connector > Email and SMS connectors.
  2. To add a new SMS connector, click the "Set up" button and select "Tencent".
  3. Review the README documentation for your selected provider.
  4. Complete the configuration fields in the "Parameter Configuration" section.
  5. Customize the SMS template using the JSON editor.
  6. Test your configuration by sending a verification code to your Phone number.
Connector tab
note:

If you are following the in-place Connector guide, you can skip the next section.

Set up Tencent SMS connector​

Create an Tencent Cloud account​

Go to the Tencent Cloud website and register your account if you don't have one.

Enable and Configure Tencent Cloud SMS​

  1. Sign-in with your account at the Tencent Cloud website and go to the SMS service console page.
  2. Click the “Free Trial” (免费试用) button on the SMS service page and follow the setup steps.
  3. Agree to the “Terms of SMS Service Activation” (短信开通服务条款) and click “Activate Service” (开通服务) to proceed.
  4. On the “SMS Console Overview” (短信服务控制台概览), choose “Domestic Messages”(国内消息) or “International/Hong Kong, Macao, Taiwan Messages”(国际/港澳台消息) from the sidebar based on your needs.
  5. Add a signature and template for SMS messages. Note:
    • When adding a “Signature” (签名), select “Verification Code” (验证码) under the "Applicable Scenarios" (模版类型) field.
    • When adding a template, choose “Verification Code” as the template type.
    • Include a placeholder {1} in the template content, which will be replaced by a randomly generated code.
    • Templates with multiple placeholders are not supported. Use or create a single-placeholder template.
  6. Submit the signature and template for approval. After submission:
    • Wait for them to take effect.
    • Test SMS can be sent from the “SMS Console Overview” (短信服务控制台概览). Approved signatures and templates can be used directly for testing, or use the testing templates provided if they are still under review.
    • Ensure your account has sufficient balance for testing and pre-register the test phone number to receive SMS successfully.

For detailed guidance, click the “Getting Started Guide” (新手配置指引) tab in the SMS Console Overview.

Compose the connector JSON​

  1. Go to the “SMS Console Overview” and hover over your avatar in the top-right corner. Navigate to “Access Management > Access Keys > API Keys” to generate your AccessKey ID and AccessKey Secret after completing security verification. Please keep them properly.
  2. From the “Domestic Messages” (国内消息) or “International/Hong Kong, Macao, Taiwan Messages” (国际/港澳台消息) tab, retrieve the “Signature Name” (签名名称) and “Template Code” (模版 CODCE).
    • For testing templates, check the “Getting Started” (快速开始) tab under "Test-Exclusive Templates" (测试专用签名模版).
  • Configure the Tencent Cloud SMS Connector with the following fields:
    • accessKeyId and accessKeySecret: Use the credentials from step 1.
    • signName: The signature name obtained in step 2. This applies to all templates.
    • Add multiple templates for different scenarios if needed. Example for a single template:
      • templateCode: Retrieved from the “Template Code” in step 2.
      • usageType: Specify one of Register, SignIn, ForgotPassword, or Generic for different scenarios (Logto-specific property).
      • Ensure templates are configured for all four scenarios to complete the flow.
    • sdkAppId: Found in “Application Management” (应用管理).
    • region: Specify the supported region from the “Sending Documentation” (发送文档).

Test Tencent Cloud SMS connector​

You can type in a phone number and click on "Send" to see whether the settings can work before "Save and Done".

That's it. Don't forget to Enable connector in sign-in experience.

Config types​

NameType
accessKeyIdstring
accessKeySecretstring
signNamestring
regionstring
sdkAppIdstring
templatesTemplate[]
Template PropertiesTypeEnum values
templateCodestringN/A
usageTypeenum 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 Tencent connector should be available now.

Enable Tencent connector in Sign-in Experience​

Once you create a connector successfully, you can enable phone number-based passwordless login and registration.

  1. Navigate to Console > Sign-in experience > Sign-up and sign-in.
  2. Set up sign-up methods (Optional):
    1. Select "Phone number" or "Email or phone number" as the sign-up identifier.
    2. "Verify at sign-up" is forced to be enabled. You can also enable "Create a password" on registration.
  3. Set up sign-in methods:
    1. Select Phone number as one of sign-in identifiers. You can provide multiple available identifiers (email, phone number, and username).
    2. Select "Verification code" and / or "Password" as the authentication factor.
  4. Click "Save changes" and test it in "Live preview".
Sign-in Experience tab

In addition to registration and login via OTPs, you can also have password recovery and -based security verification enabled, as well as linking Phone number to profile. See End-user flows for more details.

Testing and Validation​

Return to your Next.js (App Router) app. You should now be able to sign in with Tencent. Enjoy!

Further readings​

End-user flows: Logto provides a out-of-the-box authentication flows including MFA and enterprise SSO, along with powerful APIs for flexible implementation of account settings, security verification, and multi-tenant experience.

Authorization: Authorization defines the actions a user can do or resources they can access after being authenticated. Explore how to protect your API for native and single-page applications and implement Role-based Access Control (RBAC).

Organizations: Particularly effective in multi-tenant SaaS and B2B apps, the organization feature enable tenant creation, member management, organization-level RBAC, and just-in-time-provisioning.

Customer IAM series Our serial blog posts about Customer (or Consumer) Identity and Access Management, from 101 to advanced topics and beyond.