Download the PHP package liplum/flarum-sync-profile without Composer
On this page you can find all versions of the php package liplum/flarum-sync-profile. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download liplum/flarum-sync-profile
More information about liplum/flarum-sync-profile
Files in liplum/flarum-sync-profile
Package flarum-sync-profile
Short Description The user profile synchronization when authenticated by an external identity provider.
License MIT
Informations about the package flarum-sync-profile
Flarum Sync Profile
A Flarum extension to sync user profile(attributes) when authenticated by an external identity provider. This extension provides support for syncing:
- Nickname
- Avatar
- Groups
- Bio
- Masquerade Attributes
Get Started
Installation:
Update:
You'll need to start the Flarum Scheduler.
Sync
Flarum Setup
First, set both sync-users-endpoint and sync-user-endpoint.
If the sync-users-endpoint is set, all user profiles will be synced hourly.
If the sync-user-endpoint is set, each user profile will be synced when they were registered.
The payload of the hook request is in JSON:API which Flarum uses,
and the authentication can be checked via the Authorization
header.
For security issue, you should set the Authorization header in the config.php instead of barely display on extension settings page for anyone who has the extension management permission.
Here is something like the Flarum backend would request the hook.
For single user:
For multiple users:
And the backend should handle the sync request and respond a the user attributes in JSON:API:
For single user:
For multiple users:
Backend Setup
Taking the express.js backend server as an example, you can set up the following routes.
Manually Sync
You can run the command to manually trigger sync all users.
Webhook
Set the webhook token for authentication. If it's left empty, the webhook won't work.
The webhook endpoint is /api/sync-profile/webhook/{api}
.
A full qualified URL is https://fourm.example.com/api/sync-profile/webhook/{api}
.
Taking the express.js backend server as an example, you can set up the following routes.