For our new friends

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 Discord sign-in experience (user authentication) with Vue and  Logto.

Prerequisites

• A running Logto instance. Check out the get started page if you don't have one.
• Basic knowledge of Vue.
• A usable Discord 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 "Vue" 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

tip

• Logto Vue SDK is built with the composition API and leveraging the composables, therefore it is only compatible with Vue 3.
• The tutorial video is available on our YouTube channel.
• The full sample project is available on our SDK repository.

Installation

npm

npm i @logto/vue

Yarn

yarn add @logto/vue

pnpm

pnpm add @logto/vue

Init LogtoClient

note

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

Import and use createLogto to install Logto plugin:

// main.ts
import { createLogto, LogtoConfig } from '@logto/vue';
import { createApp } from 'vue';
import App from './App.vue';

const config: LogtoConfig = {
  endpoint: '<your-logto-endpoint>', // E.g. http://localhost:3001
  appId: '<your-application-id>',
};

const app = createApp(App);

app.use(createLogto, config);
app.mount('#app');

Implement sign-in

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.

---

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".

Implement a sign-in button

We provide two composables useHandleSignInCallback() and useLogto() which can help you easily manage the authentication flow.

note

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/vue';

const { signIn } = useLogto();
const onClickSignIn = () => signIn('http://localhost:3000/callback');

<button @click="onClickSignIn">Sign In</button>

Handle redirect

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:

// CallbackView.vue
import { useHandleSignInCallback } from '@logto/vue';
const { isLoading } = useHandleSignInCallback(() => {
  // Navigate to root path when finished
});

<template>
  <!-- When it's working in progress -->
  <p v-if="isLoading">Redirecting...</p>
</template>

Finally insert the code below in your /callback route which does NOT require authentication:

// Assuming vue-router
const router = createRouter({
  routes: [
    {
      path: '/callback',
      name: 'callback',
      component: CallbackView,
    },
  ],
});

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

import { useLogto } from '@logto/vue';

const { signOut } = useLogto();
const onClickSignOut = () => signOut('http://localhost:3000');

<button @click="onClickSignOut">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 Vue SDK, the isAuthenticated status can be checked by using the useLogto composable. In the example code below, we can use it to programmatically show and hide the sign-in and sign-out buttons. Also we'll use getIdTokenClaims to get the ID of the currently logged-in user.

<script setup lang="ts">
import { useLogto } from "@logto/vue";
import { ref } from "vue";

const { isAuthenticated, getIdTokenClaims, signIn, signOut } = useLogto();
const userId = ref<string>();

if (isAuthenticated.value) {
  (async () => {
    const claims = await getIdTokenClaims();
    userId.value = claims.sub;
  })();
}

</script>

<template>
  <p v-if="userId">Logged in as {{ userId }}</p>
  <button v-if="!isAuthenticated" @click="onClickSignIn">Sign In</button>
  <button v-else @click="onClickSignOut">Sign Out</button>
</template>

Test your integration

Open your Vue 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 Discord connector

To add a social connector, go to the "Connector" tab in the Admin Console, then click on "Social Connectors". From there, click "Add Social Connector".

In the openning modal, select "Discord" 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 Discord OAuth app

Register a developer application

• Visit Discord Developer Portal and sign in with your Discord account.
• Click the New Application button to create an application, choose a name for it (Ex: LogtoAuth), tick the box and click Create.
• Go to OAuth2 page and click Reset Secret
• Take note of the CLIENT ID and CLIENT SECRET fields
• Add the valid redirects (Ex: http://auth.mycompany.io/callback/${connector_id}). The connector_id can be found on the top bar of the Logto Admin Console connector details page.

Configure Logto

Config types

Name	Type
clientId	string
clientSecret	string

clientId

clientId is the CLIENT ID field we saved earlier. (You can find it in the Oauth2 Page in Discord Developer Portal.)

clientSecret

clientSecret is the CLIENT SECRET we saved earlier. (If you've lost it you need to click Reset Secret)

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 Discord connector should be available now.

Enable Discord connector in Sign-in Experience

Switch to the "Sign-in Experience" tab, then click the "Sign-up and Sign-in" tab.

note

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 "None" for the "Sign-up identifier" to provide minimum sign-up effort for Discord sign-in, which may increase your conversion rate.

In the "Social sign-in" section, add "Add Social Connector" and choose "Discord". Then you should be able to see a button with text "Continue with Discord" in the preview section.

Finally, click "Save Changes" on the bottom right corner.

Testing and Validation

Return to your Vue app. You should now be able to sign in with Discord. 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.