Generating an API access key

A CDP user account (a user or a machine user) must have API access credentials to access CDP services through the CDP CLI or API.

Required roles: Users who have the IAMUser role can generate an API access key from their own account page. As a CDP administrator or PowerUser, you can generate an API access key for all user accounts.

Generate your own access key

Steps

  1. Sign in to the CDP console.

  2. Click on your user name in the bottom left corner and then select Profile.
  3. On the user profile page that appears, click Generate Access Key.
  4. From the CDP home page, click Management Console.
  5. On the side navigation panel, click Users.
  6. On the Users page, click the name of the user or machine user account for which you want to generate an access key.
  7. On the user account page, go to the Access Keys section and click Generate Access Key.
  8. CDP creates the key and displays the information on the screen.

    Copy the access key and private key to a text file and send it to the CDP user who requires it. The private key is a very long string of characters. Make sure that you copy the full string. You can optionally download the credentials file containing the access key information.
  9. Click OK to exit the access key window.

Once you've generated the access key, you can configure CDP CLI, SDK, or other utilities that require it.

Generate an access key for another user or machine user (admin only)

Steps

  1. Sign in to the CDP console.

  2. From the CDP home page, click Management Console.
  3. On the side navigation panel, click Users.
  4. On the Users page, click the name of the user or machine user account for which you want to generate an access key.
  5. On the user account page, go to the Access Keys section and click Generate Access Key.
  6. CDP creates the key and displays the information on the screen.

    Copy the access key and private key to a text file and send it to the CDP user who requires it. The private key is a very long string of characters. Make sure that you copy the full string. You can optionally download the credentials file containing the access key information.
  7. Click OK to exit the access key window.

Once you've generated the access key, you can configure CDP CLI, SDK, or other utilities that require it.