Social Auth

Über

Das Plugin fügt dem Login-Screen des Payload-v3-Admins Social Sign-in hinzu. Über die Komponente `SocialLoginButtons` im `beforeLogin`-Hook erscheint eine Reihe von Provider-Buttons, und für jeden Provider, der in den Optionen konfiguriert ist, registriert das Plugin einen OAuth-Endpunkt in `config.endpoints`. Unterstützt werden GitHub, Google, Facebook, Twitter und LinkedIn. Ein Provider ist nur aktiv, wenn sowohl `clientId` als auch `clientSecret` gesetzt sind. Die Provider werden einzeln unter dem Schlüssel `providers` aktiviert. Optional lassen sich pro Provider `callbackURL` und `scope` setzen, wobei für `scope` die Standardwerte des jeweiligen Providers gelten. Für jede Auth-Collection ergänzt das Plugin die Felder `socialProvider`, `socialId`, `socialProviders` und `socialProvidersList` als versteckte Sidebar-Felder. `socialProviders` ist ein Array aus Provider- und ID-Paaren, `socialProvidersList` enthält eine kommaseparierte Liste der verknüpften Provider und wird per `beforeChange`-Hook befüllt. Hat eine Collection noch kein `email`-Feld, legt das Plugin ein Pflichtfeld mit eindeutigem Wert an. Sobald eine Social-Identität verknüpft ist, lässt sich die E-Mail-Adresse nicht mehr ändern. Die Listenspalte wird außerdem an `defaultColumns` der Listenansicht angehängt. Neben `providers` und `disabled` kennt die README die Optionen `jwtSecret`, `cookieName`, `autoCreateUser`, `onAuthSuccess` und `onAuthFailure`. Der Einstiegspunkt des Plugins liest jedoch nur `disabled` und `providers` aus. Vor dem Einsatz der übrigen Optionen sollten die Endpunkt-Handler geprüft werden, `defaultRole` taucht nur in den Typen auf. Außerdem weichen die Standard-Callback-Pfade in README und Typdefinitionen voneinander ab (`/api/oauth/<provider>` bzw. `/api/auth/<provider>/callback`). Die Redirect-URI im jeweiligen Developer-Portal sollte deshalb mit dem tatsächlich laufenden Build übereinstimmen. Voraussetzung ist `payload` ^3.82.1 als Peer-Dependency, zur Laufzeit wird `jsonwebtoken` benötigt.

Paketinformationen

Paketname

payload-social-auth

Neueste Version

1.0.0

Entpackte Größe

127 kB

Lizenz

MIT

Wöchentliche Downloads

2

Zuletzt veröffentlicht

6. Mai 2026