OAuth2 Client

The Rocket.Chat App OAuth2 workflow is a feature that lets developers handle OAuth2 authentication on their apps directly within Rocket.Chat

OAuth2 Setup

  1. Import the methods needed from the IOAuth2 and OAuth2 definitions in the main class of your app.

import { IAuthData } from '@rocket.chat/apps-engine/definition/oauth2/IOAuth2';
import { createOAuth2Client } from '@rocket.chat/apps-engine/definition/oauth2/OAuth2';
  1. When setting up the app configurations using the extendConfiguration method, we create an instance of the createOAuth2Client imported above.

protected async extendConfiguration(configuration: IConfigurationExtend): Promise<void> {
    const oauthConfig = {
            alias: 'test',
            accessTokenUri: 'https://oauth2.googleapis.com/token',
            authUri: 'https://accounts.google.com/o/oauth2/v2/auth',
            refreshTokenUri: 'https://oauth2.googleapis.com/token',
            revokeTokenUri: 'https://oauth2.googleapis.com/revoke',

    try {
        await createOAuth2Client(this, oauthConfig)
    } catch (error) {
        this.getLogger().error('[extendConfiguration] error', error);
  • The createOAuth2Client method takes in two parameters:

  • Now calling the setup(configuration) method on the createOAuth2Client creates all the setup APIs you need to use.

Use OAuth2

After setup, use the OAuth2Client to access multiple methods like getAccessTokenForUser, revokeUserAccessToken etc.


Gets the token information for a specific user, if available. This receives the user instance as a parameter and returns data about the authenticated user.

await createOAuth2Client(this, this.config).getAccessTokenForUser(user);


Returns the authorization URL to which the user must be redirected in order to authorize access to the application.

const url = await createOAuth2Client(this, this.config).getUserAuthorizationUrl(user);


Refreshes the user's access token. This is useful when the user access token has expired.

await createOAuth2Client(this, this.config).refreshUserAccessToken(user, persis);


Revokes user's access token in the service provider. When successfully executed, users will need to be authenticated again before using the service.

await createOAuth2Client(this, this.config).revokeUserAccessToken(user, persis);

Last updated

Rocket.Chat versions receive support for six months after release.