IBM Support

How to invoke Blueworks Live APIs with a user context parameter?

How To


Summary

The Service ID can invoke APIs with a user context parameter, when appropriate.

The response is limited to only those elements visible to that user.

Steps

The account admin must enable User Context on the Account Information page of the Blueworks Live Admin console.

Screen capture

To provide the user context, pass an X-On-Behalf-Of header in your request with the user name as the value.


The response includes only the resources that the specified user has access to or is permitted to see in the account.

For example, if the /bwl/blueprints API is called with a user context, only the blueprints that are visible to the specified user are shown. Or, if the /bwl/blueprints/{blueprint-id} API is called with a user context to get the details of a specific blueprint and the blueprint is not accessible to the specified user, the command produces a "403" response.

Not all APIs are enabled for user context. If you try to pass a user context to an API that is not enabled for it, the command produces a "400" response.


Related Information

Document Location

Worldwide


[{"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SS2MKC","label":"IBM Blueworks Live"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB76","label":"Data Platform"}}]

Document Information

More support for:
IBM Blueworks Live

Software version:
All Versions

Document number:
960406

Modified date:
08 April 2025

UID

ibm10960406

Manage My Notification Subscriptions