IBM Watson Discovery account details

To establish a connection to IBM® Watson Discovery, you must add an account that defines the account details to connect with. You can define these details by creating a configuration object in the App Connect Dashboard, the Red Hat® OpenShift® web console or CLI, or the Kubernetes CLI.

Account parameters

You can define one or more accounts for IBM Watson Discovery.

For each account that you require, you can specify a new set of account details in any of the following ways:

  • If you are using the App Connect Dashboard, either complete the Account details fields in the Create configuration panel, or specify the account parameters in an accounts.yaml file before importing it into the Create configuration panel. For more information, see Accounts type.
  • If you are using the Red Hat OpenShift web console or CLI, or the Kubernetes CLI, specify the account parameters in an accounts.yaml file, and then use this configuration file to create a configuration object. For more information, see Creating the file for a configuration object of type Accounts.

The set of required and optional Account fields or parameters are listed in the following table.

For information about locating the values for these account parameters, see Locating the values for the account parameters.

Field Parameter Values Condition Description

Account name

name

User defined

Required

The name of a Watson account that is used in the exported flow.

API key

or

User name and Password

apiKey

or

username and password

User defined

Required
  • For apiKey, specify the API key that was generated for the Watson instance. Required if the instance supports token-based Identity and Access Management (IAM) authentication.
  • For username and password, specify the user name and password that were generated for the Watson instance. Required if the instance uses Cloud Foundry service credentials for authentication.

Base URL

baseUrl

User defined

Required

The base URL for the Watson service endpoint.

Locating the values for the account parameters

You can find the connection values on the Service credentials page for the Watson service instance in IBM Cloud:

  1. Log in to IBM Cloud.
  2. Go to the IBM Cloud Dashboard, and click the Watson service instance that you want to work with
  3. Click Service credentials and click View credentials.

Example

Remember: An accounts.yaml file that defines one or more accounts must always begin with the following line:
accounts:

  watsondiscovery:
    - name: Account 1
      credentials:
        apiKey: aBCDefghiJKlmn37oP0qrSTUvwxZmUUpa-2E4AGjt1
      endpoint:
        baseUrl: 'https://api.us-south.discovery.watson.cloud.ibm.com/instances/123f45f0-6788-4321-6789-3c96b8f4973a'