IBM Cloudant account details

To establish a connection to IBM® Cloudant®, 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
Locating the values for the account parameters
Examples

Account parameters

You can define one or more accounts for IBM Cloudant.

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 an IBM Cloudant account that is used in the exported flow.
Cloudant username	username	User defined	Optional	The username that was generated for the IBM Cloudant instance. Required if the instance uses legacy (Cloud Foundry) credentials for authentication.
Cloudant password	password	User defined	Optional	The password that was generated for the IBM Cloudant instance. Required if the instance uses legacy (Cloud Foundry) credentials for authentication.
Cloudant API key	apiKey	User defined	Optional	The API key that was generated for the IBM Cloudant instance. Required if the instance supports IAM authentication only, or supports both legacy credentials and IAM.
Cloudant host	url	User defined	Optional	The hostname of the IBM Cloudant instance. Required if the instance supports Identity and Access Management (IAM) authentication only, or supports both legacy credentials and IAM.

Locating the values for the account parameters

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

Log in to IBM Cloud.
Go to the IBM Cloud Dashboard, and click the IBM Cloudant service instance that you want to work with
Click Service credentials and click View credentials. (If you want to define new credentials to use, click New credential.)

Examples

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

Example 1 (Connecting to an instance that supports IAM only, or both legacy credentials and IAM):

  cloudantdb:
    - name: Account 1
      credentials:
        apiKey: aBCDefghiJKlmn37oP0qrSTUvwxZmUUpa-2E4AGjt1
      endpoint:
        url: 2a123bcd4e-5f6g-78fg-123hi-jklm90123nop4-bluemix.cloudantnosqldb.appdomain.cloud

Example 2 (Connecting to an instance that uses legacy credentials):

  cloudantdb:
    - name: Account 1
      credentials:
        username: a123bcd4e-5f6g-78fg-123hi-jklm90123nop4-bluemix
        password: 1234abcdefgh5678i90123jk45678ca90b845c784b2d14faccde49e7e2f2230b
      endpoint: {}