Documentation Index

Fetch the complete documentation index at: https://docs.rocket.chat/llms.txt

Use this file to discover all available pages before exploring further.

Additional OAuth Methods

Prev Next

Rocket.Chat supports several other OAuth methods. On this page, we cover the configuration parameters of the remaining methods. You can find the values of the required fields such as the client ID and secret from your OAuth provider.

Apple OAuth

To enable Apple OAuth on your workspace:

  • Go to Manage → Workspace → Settings → OAuth.

  • In the Apple tab, enable Sign in with Apple.

  • Enter the values for the following fields:

    • Accounts_OAuth_Apple_id

    • Accounts_OAuth_Apple_secretKey

    • Accounts_OAuth_Apple_iss

    • Accounts_OAuth_Apple_kid

If you want Apple login enabled only on mobile, you can leave all fields empty.

X OAuth

Use the X social media platform as an authentication provider to sign your users into your Rocket.Chat workspace. On the X Developer Portal, navigate to the Apps page to create or view your existing apps.

To enable X OAuth on your workspace:

  • Go to Manage → Workspace → Settings → OAuth.

  • In the Twitter tab, enable Twitter Login.

  • Enter the values for the following fields:

    • Twitter Id: The OAuth ID of your Twitter OAuth app.

    • Twitter Secret: Your Twitter OAuth app secret.

Drupal OAuth

Drupal is a free and open-source content management system used to build websites and web apps. It provides a user authentication system that supports accounts, roles, and permissions. Rocket.Chat offers you the option to authenticate your users with Drupal as an OAuth provider.

Drupal OAuth is made possible with Simple OAuth. Follow this guide to create client credentials.

To enable Drupal OAuth in your workspace:

  • Go to Manage → Workspace → Settings → OAuth.

  • In the Drupal tab, enable the Drupal Login Enabled option.

  • Enter the values for the following fields:

    • Drupal Server URL: Your server URL. Example https://domain.com (excluding trailing slash)

    • Drupal oAuth2 Client ID: The OAuth ID from the Drupal configuration.

    • Drupal oAuth2 Client Secret: Your Drupal OAuth secret.

Dolphin OAuth

Dolphine 7.x will no longer be supported. Refer to the new Dolphin solution for more information.

Visit this configuration page to see how you can link your workspace to Dolphin.

To enable Dolphin OAuth in your workspace:

  • Go to Manage → Workspace → Settings → OAuth.

  • In the Dolphin tab, click Enable to enable Dolphin OAuth.

  • Enter the values for the following fields:

    • URL: Enter the URL from the information section of the OAuth2 module.

    • Id: Dolphin connect ID.

    • Secret: Dolphin connect secret.

    • Login Style: A dropdown to select the login style. You can choose Redirect, Popup, or the Default option.

    • Button Text: Text to be displayed on the OAuth button.

Custom OAuth: Okta

Okta is a widely used identity management platform that provides secure authentication and user management. You can use Okta as your OAuth method by creating a custom method in Rocket.Chat.

First, create an OAuth app in Okta:

  • Go to your Okta developer console and create a new OAuth app for a web application.

  • Fill in the required information and save.

  • Okta generates the credentials you need for configuration.

Then, create a custom OAuth method in your Rocket.Chat workspace:

  • Go to Manage → Workspace → Settings → OAuth.

  • Click Add custom OAuth and set a name for the new integration.

  • Fill in the required fields using the credentials from your Okta app, then click Save changes.

Proxy

A proxy server in the context of OAuth refers to an intermediary server that acts as an OAuth provider on behalf of an application. With this option, you can set up a proxy service as an OAuth method.

  • Proxy Host: The OAuth proxy host.

  • Proxy Services: The OAuth proxy service.