Authentication

Authentication#

To interact with the watsonx.data integration platform via the SDK, you must first authenticate. The SDK supports multiple authentication methods.

IAM Authentication (SaaS)#

You can generate an API key from your IBM Cloud account at: https://cloud.ibm.com/iam/apikeys

To authenticate, pass your API key into the ibm_watsonx_data_integration.common.auth.IAMAuthenticator class.

>>> from ibm_watsonx_data_integration.common.auth import IAMAuthenticator
>>>
>>> # Replace with your actual API key
>>> auth = IAMAuthenticator(                       # pragma: allowlist secret
...     api_key='your-api-key',                    # pragma: allowlist secret
...     base_auth_url='https://cloud.ibm.com'
... )

Note

The base_auth_url should be the host URL where you created your IAM API key. In the example above, the base_auth_url is set to 'https://cloud.ibm.com' since the API key was created at ‘https://cloud.ibm.com/iam/apikeys’.

Bearer Token Authentication (SaaS)#

Alternatively, you can authenticate using a bearer token by passing it into the ibm_watsonx_data_integration.common.auth.BearerTokenAuthenticator class.

For more information on how to generate bearer tokens, please refer to this page.

>>> from ibm_watsonx_data_integration.common.auth import BearerTokenAuthenticator
>>>
>>> # Replace with your actual bearer token
>>> auth = BearerTokenAuthenticator(               # pragma: allowlist secret
...     bearer_token='your-bearer-token'           # pragma: allowlist secret
... )

Zen Api Key Authentication (on-prem)#

For on-premises authentication, use the ibm_watsonx_data_integration.common.auth.ZenApiKeyAuthenticator class. Pass in your username and Zen API key into the username and zen_api_key fields respectively:

>>> from ibm_watsonx_data_integration.common.auth import ZenApiKeyAuthenticator
>>>
>>> # Replace with your actual username and zen_api_key
>>> auth = ZenApiKeyAuthenticator(               # pragma: allowlist secret
...     username='your-username',                # pragma: allowlist secret
...     zen_api_key='your-zen-api-key'           # pragma: allowlist secret
... )

ICP4D Authentication (on-prem)#

For on-premises authentication, alternatively you can also use the ibm_watsonx_data_integration.common.auth.ICP4DAuthenticator class. Pass in your username and cluster url into the username and url fields respectively. Finally, you may authenticate using either a traditional password or your zen API key by using the password or zen_api_key fields respectively. Only one of password or zen_api_key is required.

>>> from ibm_watsonx_data_integration.common.auth import ICP4DAuthenticator
>>>
>>> # Replace with your actual username and password
>>> auth = ICP4DAuthenticator(                   # pragma: allowlist secret
...     url='your-cluster-url',                  # pragma: allowlist secret
...     username='your-username',                # pragma: allowlist secret
...     password='your-password'                 # pragma: allowlist secret
...     # zen_api_key='your-zen-api-key'         # pragma: allowlist secret
... )

Using the Authenticator#

Once authenticated with either method, pass the auth object to the Platform class to begin interacting with the SDK.

Section Contents