How to Implement Custom Protected Routes with Keycloak in a Next.js?

I’m using Keycloak for authentication in my Next.js application and want to protect specific routes, like /contact, so that only authenticated users can access them. I’ve initialized Keycloak in my AuthProvider component, but I’m unsure how to redirect unauthenticated users to the login page when they try to access protected routes.

library used are keycloak-js and zustand

The AuthProvider component acts as a gatekeeper for the app, using Keycloak to manage user authentication. When the component mounts, it sets up a Keycloak instance based on your configuration and checks if the user is logged in.

If the user is authenticated, their profile information is loaded, and the app is updated to reflect their logged-in status. However, if they’re not authenticated and try to access protected routes (like /contact), they’ll be redirected to the Keycloak login page. While this is happening, a loading spinner is displayed to let users know the authentication process is in progress.

Overall, this component ensures that only authenticated users can access certain parts of the app


import Loading from "@/error-pages/Loading";
import Keycloak from "keycloak-js";
import { useKeycloakStore } from "@/hooks/useKeycloak";
import { keycloakConfig } from "@/utils/keycloakConfig";
import { usePathname } from "next/navigation";
import React, { ReactNode, useLayoutEffect, useState } from "react";

export default function AuthProvider({ children }: { children: ReactNode }) {
  const path = usePathname();
  const [loading, setIsloading] = useState(false);
  const { initializeKeycloak, setAuthenticated, setProfile } =
    useKeycloakStore();

  useLayoutEffect(() => {
    const protectedRoutes = ["/contact"];
    const keycloakInstance = new Keycloak(keycloakConfig);
    initializeKeycloak(keycloakInstance);
    
    // INITIALIZE KEYCLOAK
    keycloakInstance
      .init({
        onLoad: "check-sso",
        scope: "offline_access",
      })
      .then((auth) => {
        if (auth) {
          keycloakInstance?.loadUserProfile().then((item: any) => {
            setProfile(item);
          });
          setAuthenticated(true);
        } else {
          // If User is not authenticated
          if (!keycloakInstance?.authenticated) {
            setIsloading(true);
            console.log("❌ Not Authenticated");
            // If User is not authenticated and page is protected
            if (protectedRoutes.includes(path)) {
              console.log("❌ Unauthorize need to login");
              // send user to login page
              keycloakInstance?.login(); // this keeps my page refreshing or redirect
              setIsloading(false);
            }
          }
        }
      });
  }, [setAuthenticated, path, initializeKeycloak, setProfile]);

  if (loading) return <Loading />;
  return <>{children}</>;
}


KEYCLOAK CONFIG


export const keycloakConfig = {
  url: process.env.NEXT_PUBLIC_KEYCLOAK_URL,
  realm: process.env.NEXT_PUBLIC_KEYCLOAK_REALM,
  clientId: process.env.NEXT_PUBLIC_KEYCLOAK_CLIENT_ID,
};


Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật