Using API key-based authentication for IBM Planning Analytics as a Service with MCSP

Edit online

This topic contains details for API key-based authentication for Planning Analytics as a Service with MCSP.

If you are on another offering (that is, Planning Analytics on Cloud, Planning Analytics Advanced Certified Containers, or Planning Analytics Local), use OAuth to authenticate with MCSP. For more details, see Configuring authorized applications (OAuth).

About this task

You must have access to IBM® Planning Analytics Workspace to generate an API key

Note: All API keys must belong to a named user.

Procedure

  1. Click your user name on the IBM Planning Analytics Workspace home page, then click Manage API Keys.
  2. On the API Keys page, click Generate Key.
  3. Enter an API Key name and, optionally, a Description.
  4. Click Create.
  5. When the key is successfully created, click Copy to clipboard and save the key in a secure manner. The API key is displayed for a brief period of time and is unrecoverable after the success notification closes.

  7. Use basic authentication to log into Planning Analytics as a Service with MCSP at `https://<PA-SaaS-url>/api/<tenantID>/v0/rolemgmt/v1/users/me`.

Example

Use can use basic authentication to log into Planning Analytics as a Service with MCSP at `https://<PA-SaaS-url>/api/<tenantID>/v0/rolemgmt/v1/users/me`.

For example, if your Planning Analytics as a Service URL is `https://us-east-1.planninganalytics.saas.ibm.com/`, and your tenant ID is 123xyv, you'd use `https://us-east-1.planninganalytics.saas.ibm.com/api/123xyz/v0/rolemgmt/v1/users/me` to log in.

Log in with the user name apikey and use the API key that you generated as the password. The login returns a paSession cookie that can be reused in additional calls to the Planning Analytics databases or Workspace API endpoints.