search

sourabpramanik / payload-auth-plugin

Authentication plugin for Payload CMS
https://npmjs.com/package/payload-auth-plugin
MIT License
65 stars 3 forks source link
authentication nextjs oauth oauth2 oidc payload payload-plugin payloadcms saml sso

readme

cover image

Note: This plugin supports all versions of Payload CMS starting from version 3.0 and above.

Authentication plugin for PayloadCMS

This plugin is designed to simplify the integration of multiple Open Authorization (OAuth) and OpenID Connect providers with Payload CMS. Developers can quickly and effortlessly set up authentication mechanisms by leveraging pre-configured providers.

How it works?

The initial goal in developing this plugin was to abstract its configurations and the resources it utilizes, minimizing the setup required by developers. This way, integrating any supported provider with Payload CMS involves minimal effort.

There is a scope for future improvements to make every implementation more and more flexible and straightforward

Collections

This plugin creates an Accounts collection with the slug accounts, which includes all necessary fields. This collection establishes a one-to-one relationship with the Users collection, allowing existing users to sign in with multiple providers. The Accounts collection stores information such as the provider's name and issuer, and it links the account to the user upon first sign-in.

A single user can have multiple accounts, but each account can be associated with only one user.

If you already have a collection with the slug accounts, it can cause a conflict and prevent the plugin from integrating successfully. To avoid this issue, make sure to change the slug before integrating this plugin.

Endpoints

For every provider with different protocols, the endpoints are already configured in the plugin. So any request that comes to the /api/oauth/**/* route will be handled by the plugin.

Signin UI component

The auth signin component is added to the signin page when you integrate the plugin. It can be customized by passing the relevant configuration options.

Usage

Install the plugin

npm install payload-auth-plugin

Or

yarn add payload-auth-plugin

Or

pnpm add payload-auth-plugin

Create an OAuth app

In your desired provider, create an OAuth application. Depending on your provider, you will need to obtain the Client ID and Client Secret from the provider's console or dashboard. Please refer to the providers list for detailed instructions on configuring a specific provider.

For example: To configure Google OAuth

  1. Add the callback/redirect URL: 
    https://[yourdomain]/api/oauth/callback/google
  2. Get the Client ID and Client Secret and set the .env variables in your Payload CMS application: 
    GOOGLE_CLIENT_ID=****************************
GOOGLE_CLIENT_SECRET=****************************

Create a new auth UI component

Create a new file /src/components/Auth/index.ts to sign in with the chosen providers. 

import { Button } from '@payloadcms/ui'
import { signin } from 'payload-auth-plugin/client'
export const AuthComponent = () => {
  return (
    <form
      action={async () => {
        'use server'
        signin('google')
      }}
      method="GET"
      className="w-full"
    >
      <Button type="submit" className="w-full !my-0">
        Sign in with Google
      </Button>
    </form>
  )
}

Go ahead and customize the component's look and feel to your needs.

Configure the plugin

Import the plugin in src/payload.config.ts and set up a provider:


import { buildConfig } from 'payload/config'

// --- rest of the imports

import { adminAuthPlugin } from 'payload-auth-plugin'
import { GoogleAuthProvider } from 'payload-auth-plugin/providers'

export default buildConfig({
  // --- rest of the config
  admin: {
    // --- rest of the admin config
    importMap: {
      baseDir: path.resolve(dirname),
    },
    components: {
      afterLogin: ['/components/auth#AuthComponent'],
    },
  }
  plugins: [
  // --- rest of the plugins

    adminAuthPlugin({
      providers: [
        GoogleAuthProvider({
          client_id: process.env.GOOGLE_CLIENT_ID as string,
          client_secret: process.env.GOOGLE_CLIENT_SECRET as string,
        })
      ],
    }),
  ]
})

And that's it, now you can run the dev server, and you can now sign in in with Google.

Checkout examples for better understanding

Configuration options

Configuration options allow you to extend the plugin to customize the flow and UI based on your requirements. You can explore the available options to understand their purposes and how to use them.

Options Description Default
enabled: boolean Disable or enable plugin true [OPTIONAL]
providers: array Array of OAuth providers [REQUIRED]
accountsCollectionSlug: string Accounts collection accounts [OPTIONAL]
usersCollectionSlug: string Payload users collection slug user [OPTIONAL]

Open Authorization/OpenID Connect Protocol Based Providers

This plugin includes multiple pre-configured Open Authorization (OAuth) and OpenID Connect protocol-based providers. These configurations streamline the developer experience and integrations, ensuring the authentication process is seamless and uniform across different providers.

To get started, you'll need the Client ID and Client Secret tokens, which can be found in the provider's console/dashboard. Provide these tokens to the plugin's provider settings.

Some providers may require additional domain-specific metadata that cannot be generalized. In such cases, you'll need to provide these specific details as well.

List of supported providers:

Roadmap

Ordered according to the priority

🤝 Contributing

If you want to add contributions to this repository, please follow the instructions in contributing.md.