Webex Connector 25.3
Webex Connector Help

# Configure OAuth Authentication

To retrieve information from Webex you must:

- Create a Webex integration (an OAuth application) to represent the connector.
- Run the OAuth configuration tool, which retrieves the access tokens that the connector requires to use the Webex API. You can run the OAuth configuration tool when you install the connector, or after the connector is installed.

To configure OAuth authentication (standard connector)

1. Go to the Webex website and register a new integration as described in the Webex developer documentation.

   - Specify a redirect URL that matches the value of the `RedirectUrl` parameter in the OAuth tool configuration file, `oauth_tool.cfg`. The default value is `http://localhost:7878/`.

   - Request the following permissions or "OAuth scopes".

     - `spark:kms`
     - `spark:rooms_read`
     - `spark:messages_read`
     - `spark-compliance:messages_read`
     - `spark-compliance:rooms_read`
     - `spark-compliance:recordings_read` (required for ProcessRecordings=TRUE)
   - Make a note of the client ID, client secret, and authorization URL that are provided because you will need these when you run the OAuth configuration tool.
2. Open the folder where you installed the connector.
3. Open the file `oauth_tool.cfg` in a text editor.

4. In the `[Default]` section, set any SSL or proxy settings that are required to access the repository:

   `SSLMethod` | The version of SSL/TLS to use.
   `ProxyHost` | The host name or IP address of the proxy server to use.
   `ProxyPort` | The port of the proxy server to use.

   For example:

       SSLMethod=NEGOTIATE
       ProxyHost=10.0.0.1
       ProxyPort=8080

5. In the `[OAuthTool]` section, set the following parameters:

   `AppKey` | The client ID that was provided when you created the OAuth application.
   `AppSecret` | The client secret that was provided when you created the OAuth application.
   `AuthorizeUrl` | The authorization URL that was provided when you created the OAuth application. This URL usually starts with `https://webexapis.com/v1/` and includes the scopes that you requested when creating the application.

6. Open a command-line window and run the following command:

   `oauth_tool.exe oauth_tool.cfg OAuthTool`

   Your default web browser opens to the Webex web site. The web page asks you to log in and grant consent for the connector to read your information.

7. Log in and grant consent.

   IMPORTANT: To retrieve messages from all users, you must log in and grant consent as a user who has compliance officer privileges.

   The OAuth tool creates the files `oauth.cfg` and `oauth2_sites.bin`. When you configure the connector, import the parameters from `oauth.cfg` into your task configuration. For information about how to configure a task and retrieve information from Webex, see Retrieve Information from Webex.

To configure OAuth authentication (NiFi connector)

1. Go to the Webex website and register a new integration as described in the Webex developer documentation.

   - Specify a redirect URL that matches the URL shown at the top of the OAUTH SETUP tab in NiFi (see the following steps).

   - Request the following permissions or "OAuth scopes":

     - `spark:kms`
     - `spark:rooms_read`
     - `spark:messages_read`
     - `spark-compliance:messages_read`
     - `spark-compliance:rooms_read`
     - `spark-compliance:recordings_read` (required for ProcessRecordings=TRUE)
   - Make a note of the client ID, client secret, and authorization URL that are provided because you will need these when you run the OAuth setup tool.
2. In the NiFi web interface, right-click the GetWebex processor and click Configure. Then click ADVANCED.
3. Click the OAUTH SETUP tab.
4. Enter your App Key and App Secret.
5. Click ADVANCED and specify the AuthorizeURL.

6. Click SUBMIT and follow the instructions on screen.

   You will be asked to log in and grant consent for the connector to access the information in Webex.

   IMPORTANT: To retrieve messages from all users, you must log in and grant consent as a user who has compliance officer privileges.

Copyright 2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Webex Connector 25.3

Topic Title: Configure OAuth Authentication