Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leuchtfeuer/auth0-for-mautic

This Mautic plugin connects Mautic with Auth0.
https://github.com/leuchtfeuer/auth0-for-mautic

auth0 authentication login mautic plugin sociallogin sso

Last synced: 3 months ago
JSON representation

This Mautic plugin connects Mautic with Auth0.

Awesome Lists containing this project

README

        

# Auth0 Integration by Leuchtfeuer
![Auth0Mautic](https://www.leuchtfeuer.com/fileadmin/github/auth0-for-mautic/Mautic-Auth0.png "Auth0 for Mautic")

[![Latest Stable Version](https://poser.pugx.org/leuchtfeuer/mautic-auth0-bundle/v/stable)](https://packagist.org/packages/leuchtfeuer/mautic-auth0-bundle)
[![Build Status](https://github.com/Leuchtfeuer/auth0-for-mautic/workflows/Continous%20Integration/badge.svg)](https://github.com/Leuchtfeuer/auth0-for-mautic/actions)
[![Total Downloads](https://poser.pugx.org/leuchtfeuer/mautic-auth0-bundle/downloads)](https://packagist.org/leuchtfeuer/mautic-auth0-bundle)
[![Latest Unstable Version](https://poser.pugx.org/leuchtfeuer/mautic-auth0-bundle/v/unstable)](https://packagist.org/leuchtfeuer/mautic-auth0-bundle)
[![Code Climate](https://codeclimate.com/github/Leuchtfeuer/auth0-for-mautic/badges/gpa.svg)](https://codeclimate.com/github/Leuchtfeuer/auth0-for-mautic)
[![License](https://poser.pugx.org/leuchtfeuer/mautic-auth0-bundle/license)](https://packagist.org/packages/leuchtfeuer/mautic-auth0-bundle)

This Mautic plugin allows logins and sign ups via Auth0.

## Installation
1. Open a Terminal / Console window
2. Change directory to the mautic root (i.e. `cd /var/www/mautic`)
3. Clone this repository into plugins/LeuchtfeuerAuth0Bundle (`git clone https://github.com/Leuchtfeuer/auth0-for-mautic.git plugins/LeuchtfeuerAuth0Bundle`)
4. Clear the cache (`php bin/console cache:clear`)
5. Go to Settings -> Plugins and click on "Install/Upgrade Plugins"
6. Choose the Auth0 Plugin, adapt the configuration and publish it

There is also the possibility to add this package directly into your project composer.json file by executing following command: `composer require leuchtfeuer/mautic-auth0-bundle`.

We are currently supporting following Mautic versions:

| Bundle Version | Mautic v5 Support | Mautic v4 Support | Mautic v3 Support | Mautic v2 Support |
|:--------------:|:-----------------:|:-----------------:|:-----------------:|:-----------------:|
| 2.0.x | x | - | - | - |
| 1.1.x | - | x | x | - |
| 1.0.x | - | - | x | x |

### Plugin Configuration


Configuration
Description


domain
Auth0 Domain


audience
Link to audience (should be /api/v2)


client_id
ID of the client


client_secret
Secret of the client

## Configuration
You can configure the mapping (Auth0 data -> Mautic User data) in the configuration module. There are several options:


Configuration
Title
Default (Auth0) Value


auth0_username
Username
email


auth0_email
Email
email


auth0_firstName
First Name
given_name


auth0_lastName
Last Name
family_name


auth0_signature
Signature



auth0_position
Position



auth0_timezone
Timezone



auth0_locale
Language

Use dot syntax to access arrays (i.e. `user_metadata.login_name`).

### Roles

If you want to map a role from Auth0 to your Mautic-User you have to alter your app_metadata in your Auth0-User
(where `` is the ID of your Mautic-Role):

```metadata json
{
...
"mautic": {
"role":
}
}
```

## Update from Mautic 2.x.x to Mautic 3.x.x
When updating the plugin, please make sure to change the callback URL from `../s/sso_login/Auth0Auth` to `../s/sso_login/Auth0` in your Auth0 application settings.

## Update from Mautic 4.x.x to Mautic 5.x.x
When updating the plugin, please make sure to change the callback URL from `../s/sso_login/Auth0` to `../s/sso_login/LeuchtfeuerAuth0` in your Auth0 application settings.

### Author
Leuchtfeuer Digital Marketing GmbH

[email protected]