Using IBM ID with Arc
Using IBM ID with Arc
When IBM Planning Analytics (TM1) instances are hosted on the IBM PA Cloud SaaS, you can use IBM ID credentials with Arc via the OAuth protocol.
How It Works
Arc uses OAuth to allow the same IBM ID credentials used to log in to IBM PA Cloud to also authenticate with Arc. This works with IBM ID, federated systems linked to Active Directory, and third-party identity providers such as Okta and Auth0.
Requirement: Arc must be running with SSL/TLS enabled (
usessl: trueinsettings.yml) to use OAuth.
Step 1: Request OAuth Security Keys from IBM
To get OAuth access, submit a request to IBM using the official form:
IBM OAuth Request Form
You will need to provide:
The IBM PA environments you need access to (PAW URLs)
The exact URLs that your Arc/Pulse instances will be running on, to be whitelisted
Important URL format: All Cubewise products use the same OAuth endpoint: /auth/token
For example, if Arc is accessed via https://arc.company.com, the URL provided to IBM must be:https://arc.company.com/auth/token
If a non-standard port is used, include it: https://arc.company.com:8080/auth/token
Support Ticket Template
Hello Support,
We require OAuth keys to access our environments from 3rd party applications (developed by Cubewise).
Access for the following environments is required:
⢠https://company-dev.planning-analytics.ibmcloud.com
⢠https://company.planning-analytics.ibmcloud.com
The URLs to be whitelisted for all environments above are as follows:
⢠https://company.arc.cubewisecloud.com/auth/token
⢠https://company.pulse.cubewisecloud.com/auth/tokenStep 2: Configure Connections in settings.yml
Once you receive the IBM security keys, open settings.yml and add a connection entry for each TM1 instance:
connections:
- url: https://mycompany.planning-analytics.ibmcloud.com/api/v0/tm1/instancename
name: instancename
ibmclientid: aaaa
ibmsecretid: bbbb
ibmtenantid: cccc
ibmaccountid: ddddIf multiple instances share the same IBM credentials, you can define
ibmclientid,ibmsecretid,ibmtenantid, andibmaccountidonce at the top level ofsettings.yml(outside theconnectionsblock).
Step 3: Refresh and Log In
Save settings.yml and refresh Arc. Click on the instance name ā you will be prompted to log in with your IBM ID.