Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Users / Get

  • Article
  • 2 minutes to read

Operation Information

Retrieves details about a User from IBM Blueworks Live.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type IBM Blueworks Live.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose IBM Blueworks Live in the Type pick list;
  • Give the IBM Blueworks Live KeySafe key a Title (this is the name / identifier for the IBM Blueworks Live account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
URL string URL for the Blueworks Live instance token generation and API Endpoint
Client ID string Application Client ID
Client Secret string Application Client Secret
Token string Authentication Token

Tip

To generate a Service ID in IBM Blueworks Live:

  • Navigate to Admin then Account Information;
  • Ensure Enable API access via Service IDs is ticked;
  • Click Create New, then enter a Name, Description and choose the User Management category, then click Create;
  • A JSON file will be downloaded by your browser. This JSON file contains the Client ID and Client Secret that you need to store the in relevant fields, above.

Please leave the Token field empty.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked IBM Blueworks Live account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Username username string The Username of the User to return details of Yes None provided

Output Parameters

Display Name ID Type Description
Status status string Integration call return status (ok/fail)
Error error string Any errors returned from the integration, should the Status be fail
Username username string The Username of the User
Full Name fullname string The Full Name of the User
License license string The License Type applied to the User
Admin admin string Is the User an Admin?
Active active string Is the User Active?
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document