This guide shows how you can set up OAuth integration between Microsoft accounts and Rocket.Chat.
This is achieved with the use of Azure Active Directory which is an identity service by Microsoft that provides single sign-on and other authentication methods.
Follow these steps to enable Office 365 OAuth on your Rocket.Chat instance.
To create a custom authentication method for your Rocket.Chat instance:
- Navigate to Administration > Workspace > Settings > OAuth and click on Custom OAuth and set the new OAuth integration name
- After creating the new integration, you are given the
callback URL
followed by other fields to configure
- Log in to your Azure portal then navigate to the Azure Active Directory tab
- Create a new App Registration
- Fill in the name and other fields including the redirect URI provided by Rocket.Chat when creating the new OAuth integration
After registering your new app, take note of Application (client) ID
it will be needed to configure the integration later.
- On your new app's page, navigate to Certificates and Secret tab to create a New client secret
- After creating, take note of the
client secret
immediately. It is only displayed once and is needed in configuring the integration back in Rocket.Chat
After creating the Azure Active Directory App with its secret, head over back to your Rocket.Chat O365 custom OAuth integration page and set the various fields
- Enable: Set to true to enable this OAuth integration
- URL:
https://login.microsoftonline.com/consumers
- Token Path:
/oauth2/v2.0/token
- Token Sent Via: Payload
- Identity Token Sent Via: Header
- Identity Path:
/openid/userinfo
- Authorize Path:
/oauth2/v2.0/authorize
- Scope: openid
- Param Name for access token:
access_token
- Id:
<Your Azure AD Application (client) ID>
- Secret:
<Your Azure AD client secret>
Do the configurations and Save changes
- After saving, you will find the O365 Oauth button on the login and signup page. Clicking on them brings up a popup to authenticate your Microsoft account
- Simply sign in to your Office account to authenticate
- Accept the permission required to proceed