Auth Provider

To use authProvider in refine, we have to pass the authProvider to the <Refine /> component.

import { Refine } from "@pankod/refine-core";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";

import authProvider from "./auth-provider";

const API_URL = "https://api.fake-rest.refine.dev";

const App = () => {
  return (
    <Refine
      authProvider={authProvider}
      routerProvider={routerProvider}
      dataProvider={dataProvider(API_URL)}
    />
  );
};

You can use the following auth provider examples as a starting point for your own auth provider or you can use them as it is. Check the links below to see the details of each example.

• Basic - A basic auth provider example.
• Okta - Okta, the enterprise-grade identity management service.
• Keycloak - An auth provider example with Keycloak.
• Auth0 - An auth provider example with Auth0.
• Google Auth - An auth provider example with Google Auth.
• OTP Login - An auth provider example with OTP Login.
• Appwrite - An auth provider example with Appwrite.
• Supabase - An auth provider example with Supabase.
• Strapi - An auth provider example with Strapi.
• Basic with Nextjs - A basic auth provider example with Nextjs.
• Basic with Remix - A basic auth provider example with Remix.
• Kinde - An auth provider example with Kinde.

Auth provider's methods are expected to return a Promise. So, you can use these async methods to create auth provider.

An authProvider includes the following methods:

import { AuthProvider } from "@pankod/refine-core";

const authProvider: AuthProvider = {
  // required methods
  login: () => Promise.resolve(),
  checkAuth: () => Promise.resolve(),
  logout: () => Promise.resolve(),
  checkError: () => Promise.resolve(),
  // optional methods
  register: () => Promise.resolve(),
  forgotPassword: () => Promise.resolve(),
  updatePassword: () => Promise.resolve(),
  getPermissions: () => Promise.resolve(),
  getUserIdentity: () => Promise.resolve(),
};

Refer to the Auth Provider tutorial for more information and usage examples. →

login method is used to authenticate users. It expects to return a Promise.

• If the Promise resolves, the user is authenticated and pages that require authentication will be accessible.

• If the Promise rejects, the user is not authenticated and stays on the login page.

You can use useLogin hook to call login method.

checkAuth method is used to check if the user is authenticated. Internally, it is called when the user navigates to a page that requires authentication.

checkAuth method expects to return a Promise.

• If the Promise resolves, the user is authenticated and pages that require authentication will be accessible.

• If the Promise rejects, the user is not authenticated and pages that require authentication will not be accessible and by default, the user will be redirected to the /login page.

You can use useAuthenticated hook to call checkAuth method.

logout method is used to log out users. It expects to return a Promise.

• If the Promise resolves, the user is logged out and pages that require authentication will not be accessible and by default, the user will be redirected to the /login page.

• If the Promise rejects, the user is not logged out and stays on the page.

You can use useLogout hook to call logout method.

checkError method is called when you get an error response from the API. You can create your own business logic to handle the error such as refreshing the token, logging out the user, etc.

checkError method expects to return a Promise.

• If the Promise resolves, the user is not logged out and stays on the page.

• If the Promise rejects, the logout method is called to log out the user and by default, the user is redirected to the /login route.

You can use useCheckError hook to call checkError method.

getPermissions method is used to get the user's permissions. It expects to return a Promise.

• If the Promise resolves with data, the user's permissions will be available in the usePermissions hook's data property.

• If the Promise rejects, the user's permissions will not be available and usePermissions hook throw an error.

You can use usePermissions hook to call getPermissions method.

getUserIdentity method is used to get the user's identity. It expects to return a Promise.

• If the Promise resolves with a data, the user's identity will be available in the useGetIdentity hook's data property.

• If the Promise rejects, the user's identity will not be available and useGetIdentity hook throw an error.

You can use useGetIdentity hook to call getUserIdentity method.

register method is used to register a new user. It is similar to the login method. It expects to return a Promise.

• If the Promise resolves, by default, the user will be redirected to the / page.

• If the Promise rejects, the useRegister hook will throw an error.

You can use useRegister hook to call register method.

forgotPassword method is used to send a password reset link to the user's email address. It expects to return a Promise.

You can use useForgotPassword hook to call forgotPassword method.

updatePassword method is used to update the user's password. It expects to return a Promise.

You can use useUpdatePassword hook to call updatePassword method.

These hooks can be used with the authProvider authentication and authorization operations.

• useAuthenticated
• useCheckError
• useGetIdentity
• useLogin
• useLogout
• usePermissions
• <Authenticated />
• useRegister
• useForgotPassword
• useUpdatePassword

Refer to the "Create Auth Provider From Scratch" section in the tutorial for more information →

Refer to the "Setting Authorization Credentials" section in the tutorial for more information →