IBM Support

How to use IAM service for Authentication for API use

How To


Summary

Steps to take that uses IAM authentication for automation.

Objective

These are the steps needed to set up for automation of API calls.

Environment

ALL

Steps

The setup (steps 1 and 2)
1.  Create an IBM Cloud Service ID and generate an API key at cloud.ibm.com
2.  In your Transparent Supply Environment; go to Users, select System users, and click add a system user. Give your automation a name and indicate the Service ID that you created in step 1.

Automation Calls (steps 3 - 6)
3. Using the POST call gets your Cloud IAM token:
     POST https://iam.cloud.ibm.com/identity/token Header: Content-Type: application/x-www-form-urlencoded Body: grant_type = urn:ibm:params:oauth:grant_type:apikey&apikey = YOUR_API_KEY
4. Using the IAM token generate in Step 3; generate a service token for your environment in Transparent Supply.
     POST https://transparentsupply.ibm.com/ift/identity-proxy/exchange_token/v1/organization/(org_ID) Header: Content-Type: application/json Body: <The entire json response for Step 3>
5. Use the service token in the Authorization header of your API calls to send your data to Transparent Supply.
     POST https:transparentsupply.ibm.com/ift/api/connector/fs/connector/v1/assets Header: Content-Type: Authorization: Bearer ONBOARDING_TOKEN_VALUE Body <Transparent Supply conforming XML>
6. Regenerate a service token as needed.  Service tokens expire every hour.
    

Additional Information

You need your organization ID for Step 4, which is found in the User tab by selecting the "eye" icon next to My Organization ID or by going to Onboarding -> My Organization and selecting the "eye" icon next to Organization ID.

Document Location

Worldwide


[{"Type":"MASTER","Line of Business":{"code":"LOB59","label":"Sustainability Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSNTIG3","label":"IBM Blockchain Transparent Supply"},"ARM Category":[{"code":"a8m50000000L2l6AAC","label":"Onboarding"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

More support for:
IBM Blockchain Transparent Supply

Component:
Onboarding

Software version:
All Versions

Document number:
7058369

Modified date:
24 October 2023

UID

ibm17058369

Manage My Notification Subscriptions