Configuring API access for conversational search

SmartHub Conversational Search now supports secure, authenticated access to external APIs used by agentic RAG workflows. Many connectors, enrichment systems, and LLM-driven tools rely on APIs that require OAuth authentication. This page allows administrators to configure OAuth credentials so SmartHub can safely access those systems during query processing.

OAuth configurations are reusable across Conversational Search, agentic tools, and future integrations. Once set up, the OAuth provider becomes available for model-driven workflows that perform API calls on behalf of your users or system.

Conversational Search and agentic RAG depend on a variety of external services. Many of these services require OAuth authentication. By configuring OAuth, you can ensure that SmartHub conversational search can do the following:

  • Securely access external APIs

  • Follow corporate identity/security policies

  • Avoid storing credentials in plaintext or user-provided prompts

  • Rotate credentials cleanly and centrally

Prerequisites

The following prerequisites must be completed before you can configure your OAuth provider:

  • You must have an OAuth application registered in your identity provider (Okta, Azure Active Directory, etc.). This application generates the credentials that SmartHub requires

Configure your OAuth provider

To configure a new OAuth provider, do the following:

  1. In the SmartHub administration portal, under Conversational Search, click API Authentication Settings.

  2. On the API Access page, click Add OAuth Configuration to add a new OAuth provider. Alternatively, you can click Edit to edit an existing connection.

  3. In the Name field, provide a name for your OAuth configuration.

  4. In the Client ID field, enter the client ID for your OAuth instance.

  5. In the Client Secret field, enter the client secret key for your OAuth instance.

  6. In the Authentication URL field, enter the authentication url for your OAuth instance. For example, https://auth.atlassian.com/oauth/authorize.

  7. In the Token URL, enter the token url for your OAuth instance. For example, https://auth.atlassian.com/oauth/token.

  8. In the Scope field, enter the scope definition for the specific permissions or resources SmartHub is allowed to access on behalf of the user or service. For example, if you are configuring OAuth for Jira, you may scope your permissions to read:jira-user read:jira-work write:jira-work offline_access.

  9. In the Audience field, enter the audience value for your API to specify which API or resource the access token is intended for. For example, api.atlassian.com.

  10. Click Save.