Creating task credentials for jobs

Task credentials is a user-generated API key, securely stored in Vault, that facilitates authentication for requests to services. Task credentials are used to run certain tasks in a service or to enable the execution of long-running operations, such as scheduled jobs, without interruption.

For example, a valid user API key (task credentials) is required for the following long-running tasks:

  • Model training in watsonx.ai Runtime

  • Problem solving with Decision Optimization

  • Pipelines

  • Other runtime services that accept API key references

  • Data cleansing and validation with Data Refinery

  • Data transformation with DataStage flows

Jobs require an API key for authorization. An API key is used for jobs when:

  • Creating a job schedule with a predefined key
  • Updating the API key for a scheduled job
  • Providing an API key for an ad hoc job

If your service requires task credentials to perform an operation, you are prompted to create it. Any user with an IBM Cloud account can create an API key.

Note:
  • In some situations, for example when your organization is using trusted profiles, creating user API keys might be blocked. Service administrators are responsible for defining a strategy to create and revoke task credentials.
  • You do not use task credentials when you interact with the product programmatically.
  • Only one task credential is stored per user, per account. If you change the account that you work in, you must generate a new key.

Creating task credentials from the UI

To create new task credentials:

  1. While logged in to any experience, click your avatar and then Profile and settings.
  2. Click the User API key tab.
  3. From the User API key tab of your profile, click Create a key:

A new key is created in Active state. The key automatically authorizes operations that require secure credentials. You cannot view the new user API key because it is for internal use only.

The user API key is also stored in IBM Cloud. You can view the user API keys for your IBM Cloud account at API keys.