API key

If the Data Direct data server you are connecting to uses OAuth 2.0 authentication, you must specify values for the key and secret key in the connection string.

An endpoint may require an API key before it can accept requests. A site may use a process to generate a token that must be part of the HTTP request header. The driver provides name-value pairs that can be used to set header variables. The key can be specified several ways:

  • in the URL or connection properties
  • in the optional Key field
  • via a Cognos Analytics session variable

For example, if a site generates an API key that is to be passed as a bearer token and you prefer to keep the key hidden, use the optional Key field. If the key is a bearer token, enter the value Bearer, followed by a space, followed by the API key from the site.

For more details: See the topics ClientId and ClientSecret.