Matrix API Identity

Module for managing, linking, and authenticating Matrix users and Drupal users.

Features

This module at its core provides various ways of linking a Matrix user with a Drupal user. At its simplest, it identifies a field in Drupal that contains a Matrix ID. The matrix_api module can then make use of this when sending or receiving a message.

The first part implemented is inbound messages -- if a Matrix message is sent by a user that this module can identify, then it can set the appropriate Drupal UID on the message when creating a corresponding entity (node, comment, etc).

This module will also support authentication scenarios -- primarily using Simple_OAuth as an authentication source for Matrix, and eventually supporting Keycloak or other 3rd party IDP solutions.

Post-Installation

The matrix_recipes project has a recipe to configure a Matrix ID on a user account, and configure this module to use it.

If you don't use that, create or identify a string (unformatted text) field on a user account or a linked entity (CRM contact, Profile, etc). Then go to the configuration page at Admin -> Config -> People -> Matrix Identities, and select the field.

Other options will become available there as developed.

Additional Requirements

This module requires the Matrix API module, and provides plugins for use in ECA modules. When authentication is added, that functionality will depend upon Simple_OAuth, or an external IDP.

Recommended modules/libraries

Other Matrix API modules, depending on the scenarios you want to support.

Similar projects

None known.

Supporting this Module

Patches, issues, scenarios welcome!

Community Documentation

Coming soon.