Magento Rocket Chat SSO | SSO into Rocket Chat using Magento as OAuth Server

Magento OAuth Server extenstion enables Single Sign-On (SSO) into the Rocket.Chat app using your Magento username and password. Once you configure the Rocket.Chat with Magento OAuth Server extenstion, you can login to your Rocket.Chat application using Magento credentials. OAuth Server extenstion also allows you to send custom Magento user attributes to your Rocket.Chat app as per your requirements. To know more about other features we provide in Magento OAuth Server extenstion, you can click here.

Pre-requisites : Download And Installation

Installation using Composer:

• Purchase the miniOrange OAuth Server extension.
• Go to My profile -> My Purchases
• Please ensure you are using correct access keys (My Profile - Access Keys)
• Paste the access keys in your auth.json file inside your project
• Use the below command to add the extension to your project.

  "composer require {module_name}:{version}"

• You can see the module name and list of versions in the selector below the extension module name.
• Run the following commands on command prompt to enable the extension.

php bin/magento setup:di:compile

php bin/magento setup:upgrade

Manual Installation:

• Download the miniOrange OAuth Server extension.
• Unzip all contents of the zip inside the MiniOrange/OAuth_Server directory.

{Root Directory of Magento} app code MiniOrange OAuth_server

• Run the following commands on command prompt to enable the extension.

php bin/magento setup:di:compile

php bin/magento setup:upgrade

Steps to configure Rocket.chat Single Sign-On (SSO) using Magento OAuth Server extenstion

1. Configure Rocket.chat as OAuth Client

• Sign in to your Rocket Chat instance with an administrator account and select Administration from the menu.

• Select the OAuth section under Administration.

• Click on the Add custom OAuth button on the right top-corner to create a new OAuth Application:


• In the Application Configuration tab, copy the Callback URL (For example: https://your_domain/_oauth/id) and keep it handy to save it in the miniOrange OAuth Server extenstion. You will find this URL from the highlighted section of your Rocket Chat console as shown in the below image

2. Configure Magento as OAuth Server

• In the OAuth Server Settings tab, Enter the OAuth Client name and then paste the Redirect URL that you copied earlier and save it under the Redirect URL.

• It will show you the Client ID, Client Secret and the Endpoints. Copy the Client ID, Client Secret, Scope and the Endpoints and keep it handy. You will be needing these values later to save them in your Rocket Chat client application.

• Go back to the Client application that you already created in your Rocket Chat console and save the information that you copied from the OAuth Server extenstion in Magento.
• Values to be entered in the Rocket Chat Application:

Enable:	True
URL:	https://your_magento_site_url
Token Path:	/access_token
Token Sent Via:	Payload
Identity Token Sent Via:	Header
Identity Path:	/user_info
Authorize Path:	/authorize
Scope:	profile
Param name for Access Token:	access_token
ID:	The Client ID from the OAuth Server extenstion in Magento
Secret:	The Client Secret from the OAuth Server extenstion in Magento
Login style:	Redirect
Username field:	mail
Name field:	name
Merge Users:	True
Show button on Login Page:	True



Congratulations, you have successfully configured the miniOrange Magento OAuth Server extenstion.

3. Attribute Mapping

• In the Magento OAuth Server extension, navigate to the Attribute Mapping tab.
• In the Attribute Mapping section, enter the information and click on Save .

Additional Resources

• Rocket.chat Administration Guide
• Magento OAuth Server Single sign-on (SSO).
• Magento OAuth Server extenstion