PHPackages                             liplum/flarum-sync-profile - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. liplum/flarum-sync-profile

ActiveFlarum-extension[Authentication & Authorization](/categories/authentication)

liplum/flarum-sync-profile
==========================

The user profile synchronization when authenticated by an external identity provider.

v0.2.1(1y ago)2129MITPHP

Since Dec 7Pushed 1y ago1 watchersCompare

[ Source](https://github.com/liplum/flarum-sync-profile)[ Packagist](https://packagist.org/packages/liplum/flarum-sync-profile)[ RSS](/packages/liplum-flarum-sync-profile/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (4)Used By (0)

Flarum Sync Profile
===================

[](#flarum-sync-profile)

A [Flarum](http://flarum.org) 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
-----------

[](#get-started)

Installation:

```
composer require liplum/flarum-sync-profile-core
composer require liplum/flarum-sync-profile
```

Update:

```
composer update liplum/flarum-sync-profile-core
composer update liplum/flarum-sync-profile
```

You'll need to start the [Flarum Scheduler](https://docs.flarum.org/scheduler/).

```
* * * * * cd /path-to-your-project && php flarum schedule:run >> /dev/null 2>&1
```

Sync
----

[](#sync)

### Flarum Setup

[](#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](https://jsonapi.org/) 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](https://docs.flarum.org/config/)instead of barely display on extension settings page for anyone who has the extension management permission.

```